net.sourceforge.ccxjc.it.model.pkg.indexed.novalueclass.portlet.app200
Interface FilterType

All Known Implementing Classes:

FilterTypeImpl

public interface FilterType

The filter element specifies a filter that can transform the content of portlet requests and portlet responses. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface. A filter can be restricted to one or more lifecycle phases of the portlet. Valid entries for lifecycle are: ACTION_PHASE, EVENT_PHASE, RENDER_PHASE, RESOURCE_PHASE Used in: portlet-app

Java class for filterType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="filterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="display-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}display-nameType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}filter-nameType"/>
         <element name="filter-class" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}fully-qualified-classType"/>
         <element name="lifecycle" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}string" maxOccurs="unbounded"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}init-paramType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
String	getFilterClass() Gets the value of the filterClass property.
String	getFilterName() Gets the value of the filterName property.
InitParamType[]	getInitParam()
InitParamType	getInitParam(int idx)
int	getInitParamLength()
String[]	getLifecycle()
String	getLifecycle(int idx)
int	getLifecycleLength()
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setFilterClass(String value) Sets the value of the filterClass property.
void	setFilterName(String value) Sets the value of the filterName property.
void	setInitParam(InitParamType[] values)
InitParamType	setInitParam(int idx, InitParamType value)
String	setLifecycle(int idx, String value)
void	setLifecycle(String[] values)

Method Detail

getDescription

DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

int getDescriptionLength()

setDescription

void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

DescriptionType setDescription(int idx,
                               DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getDisplayName

DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

int getDisplayNameLength()

setDisplayName

void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

DisplayNameType setDisplayName(int idx,
                               DisplayNameType value)

Parameters:

value - allowed object is DisplayNameType

getFilterName

String getFilterName()

Gets the value of the filterName property.

Returns:

possible object is String

setFilterName

void setFilterName(String value)

Sets the value of the filterName property.

Parameters:

value - allowed object is String

getFilterClass

String getFilterClass()

Gets the value of the filterClass property.

Returns:

possible object is String

setFilterClass

void setFilterClass(String value)

Sets the value of the filterClass property.

Parameters:

value - allowed object is String

getLifecycle

String[] getLifecycle()

Returns:

array of String

getLifecycle

String getLifecycle(int idx)

Returns:

one of String

getLifecycleLength

int getLifecycleLength()

setLifecycle

void setLifecycle(String[] values)

Parameters:

values - allowed objects are String

setLifecycle

String setLifecycle(int idx,
                    String value)

Parameters:

value - allowed object is String

getInitParam

InitParamType[] getInitParam()

Returns:

array of InitParamType

getInitParam

InitParamType getInitParam(int idx)

Returns:

one of InitParamType

getInitParamLength

int getInitParamLength()

setInitParam

void setInitParam(InitParamType[] values)

Parameters:

values - allowed objects are InitParamType

setInitParam

InitParamType setInitParam(int idx,
                           InitParamType value)

Parameters:

value - allowed object is InitParamType