com.crossingchannels.portal.websphere.specification.jsr286.dom

Class FilterType

java.lang.Object

com.crossingchannels.portal.websphere.specification.jsr286.dom.FilterType

public class FilterType
extends java.lang.Object

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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DescriptionType>	description
protected java.util.List<DisplayNameType>	displayName
protected java.lang.String	filterClass
protected java.lang.String	filterName
protected java.util.List<InitParamType>	initParam
protected java.util.List<java.lang.String>	lifecycle

Constructor Summary

Constructors

Constructor and Description
FilterType()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<DescriptionType>	getDescription() Gets the value of the description property.
java.util.List<DisplayNameType>	getDisplayName() Gets the value of the displayName property.
java.lang.String	getFilterClass() Gets the value of the filterClass property.
java.lang.String	getFilterName() Gets the value of the filterName property.
java.util.List<InitParamType>	getInitParam() Gets the value of the initParam property.
java.util.List<java.lang.String>	getLifecycle() Gets the value of the lifecycle property.
void	setFilterClass(java.lang.String value) Sets the value of the filterClass property.
void	setFilterName(java.lang.String value) Sets the value of the filterName property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected java.util.List<DescriptionType> description

displayName

protected java.util.List<DisplayNameType> displayName

filterName

protected java.lang.String filterName

filterClass

protected java.lang.String filterClass

lifecycle

protected java.util.List<java.lang.String> lifecycle

initParam

protected java.util.List<InitParamType> initParam

Constructor Detail

FilterType

public FilterType()

Method Detail

getDescription

public java.util.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

public java.util.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

public java.lang.String getFilterName()

Gets the value of the filterName property.

Returns:

possible object is String

setFilterName

public void setFilterName(java.lang.String value)

Sets the value of the filterName property.

Parameters:

value - allowed object is String

getFilterClass

public java.lang.String getFilterClass()

Gets the value of the filterClass property.

Returns:

possible object is String

setFilterClass

public void setFilterClass(java.lang.String value)

Sets the value of the filterClass property.

Parameters:

value - allowed object is String

getLifecycle

public java.util.List<java.lang.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

public java.util.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