net.sourceforge.ccxjc.it.model.pkg.indexed.novalueclass.javaee
Interface FilterType

All Known Implementing Classes:

FilterTypeImpl

public interface FilterType

The filterType is used to declare a filter in the web application. The filter is mapped to either a servlet or a URL pattern in the filter-mapping element, using the filter-name value to reference. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface. Used in: web-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>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/javaee}filter-nameType"/>
         <element name="filter-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
FullyQualifiedClassType	getFilterClass() Gets the value of the filterClass property.
FilterNameType	getFilterName() Gets the value of the filterName property.
IconType[]	getIcon()
IconType	getIcon(int idx)
int	getIconLength()
String	getId() Gets the value of the id property.
ParamValueType[]	getInitParam()
ParamValueType	getInitParam(int idx)
int	getInitParamLength()
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setFilterClass(FullyQualifiedClassType value) Sets the value of the filterClass property.
void	setFilterName(FilterNameType value) Sets the value of the filterName property.
void	setIcon(IconType[] values)
IconType	setIcon(int idx, IconType value)
void	setId(String value) Sets the value of the id property.
ParamValueType	setInitParam(int idx, ParamValueType value)
void	setInitParam(ParamValueType[] 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

getIcon

IconType[] getIcon()

Returns:

array of IconType

getIcon

IconType getIcon(int idx)

Returns:

one of IconType

getIconLength

int getIconLength()

setIcon

void setIcon(IconType[] values)

Parameters:

values - allowed objects are IconType

setIcon

IconType setIcon(int idx,
                 IconType value)

Parameters:

value - allowed object is IconType

getFilterName

FilterNameType getFilterName()

Gets the value of the filterName property.

Returns:

possible object is FilterNameType

setFilterName

void setFilterName(FilterNameType value)

Sets the value of the filterName property.

Parameters:

value - allowed object is FilterNameType

getFilterClass

FullyQualifiedClassType getFilterClass()

Gets the value of the filterClass property.

Returns:

possible object is FullyQualifiedClassType

setFilterClass

void setFilterClass(FullyQualifiedClassType value)

Sets the value of the filterClass property.

Parameters:

value - allowed object is FullyQualifiedClassType

getInitParam

ParamValueType[] getInitParam()

Returns:

array of ParamValueType

getInitParam

ParamValueType getInitParam(int idx)

Returns:

one of ParamValueType

getInitParamLength

int getInitParamLength()

setInitParam

void setInitParam(ParamValueType[] values)

Parameters:

values - allowed objects are ParamValueType

setInitParam

ParamValueType setInitParam(int idx,
                            ParamValueType value)

Parameters:

value - allowed object is ParamValueType

getId

String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String