net.sourceforge.ccxjc.it.model.pkg.collections.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

List<DescriptionType>	getDescription() Gets the value of the description property.
List<DisplayNameType>	getDisplayName() Gets the value of the displayName property.
String	getFilterClass() Gets the value of the filterClass property.
String	getFilterName() Gets the value of the filterName property.
List<InitParamType>	getInitParam() Gets the value of the initParam property.
List<String>	getLifecycle() Gets the value of the lifecycle property.
void	setFilterClass(String value) Sets the value of the filterClass property.
void	setFilterName(String value) Sets the value of the filterName property.

Method Detail

getDescription

List<DescriptionType> getDescription()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType

getDisplayName

List<DisplayNameType> getDisplayName()

Gets the value of the displayName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

For example, to add a new item, do as follows:

    getDisplayName().add(newItem);
 

Objects of the following type(s) are allowed in the list 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

List<String> getLifecycle()

Gets the value of the lifecycle property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the lifecycle property.

For example, to add a new item, do as follows:

    getLifecycle().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getInitParam

List<InitParamType> getInitParam()

Gets the value of the initParam property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initParam property.

For example, to add a new item, do as follows:

    getInitParam().add(newItem);
 

Objects of the following type(s) are allowed in the list InitParamType