org.eclipse.modisco.jee.webapp.webapp30
Interface FilterType


public interface FilterType

A representation of the model object 'Filter Type'. 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

The following features are supported:

See Also:
Webapp30Package.getFilterType()
Generated:
Model:
extendedMetaData="name='filterType' kind='elementOnly'"

Method Summary
 TrueFalseType getAsyncSupported()
          Returns the value of the 'Async Supported' containment reference.
  getDescription()
          Returns the value of the 'Description' containment reference list.
  getDisplayName()
          Returns the value of the 'Display Name' containment reference list.
 FullyQualifiedClassType getFilterClass()
          Returns the value of the 'Filter Class' containment reference.
 FilterNameType getFilterName()
          Returns the value of the 'Filter Name' containment reference.
  getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
  getInitParam()
          Returns the value of the 'Init Param' containment reference list.
 void setAsyncSupported(TrueFalseType value)
          Sets the value of the 'Async Supported' containment reference.
 void setFilterClass(FullyQualifiedClassType value)
          Sets the value of the 'Filter Class' containment reference.
 void setFilterName(FilterNameType value)
          Sets the value of the 'Filter Name' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
Webapp30Package.getFilterType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getDisplayName

 getDisplayName()
Returns the value of the 'Display Name' containment reference list. The list contents are of type DisplayNameType.

If the meaning of the 'Display Name' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Display Name' containment reference list.
See Also:
Webapp30Package.getFilterType_DisplayName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='display-name' namespace='http://java.sun.com/xml/ns/javaee'"

getIcon

 getIcon()
Returns the value of the 'Icon' containment reference list. The list contents are of type IconType.

If the meaning of the 'Icon' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Icon' containment reference list.
See Also:
Webapp30Package.getFilterType_Icon()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='icon' namespace='http://java.sun.com/xml/ns/javaee'"

getFilterName

FilterNameType getFilterName()
Returns the value of the 'Filter Name' containment reference.

If the meaning of the 'Filter Name' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Filter Name' containment reference.
See Also:
setFilterName(FilterNameType), Webapp30Package.getFilterType_FilterName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='filter-name' namespace='http://java.sun.com/xml/ns/javaee'"

setFilterName

void setFilterName(FilterNameType value)
Sets the value of the 'Filter Name' containment reference.

Parameters:
value - the new value of the 'Filter Name' containment reference.
See Also:
getFilterName()
Generated:

getFilterClass

FullyQualifiedClassType getFilterClass()
Returns the value of the 'Filter Class' containment reference. The fully qualified classname of the filter.

Returns:
the value of the 'Filter Class' containment reference.
See Also:
setFilterClass(FullyQualifiedClassType), Webapp30Package.getFilterType_FilterClass()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='filter-class' namespace='http://java.sun.com/xml/ns/javaee'"

setFilterClass

void setFilterClass(FullyQualifiedClassType value)
Sets the value of the 'Filter Class' containment reference.

Parameters:
value - the new value of the 'Filter Class' containment reference.
See Also:
getFilterClass()
Generated:

getAsyncSupported

TrueFalseType getAsyncSupported()
Returns the value of the 'Async Supported' containment reference.

If the meaning of the 'Async Supported' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Async Supported' containment reference.
See Also:
setAsyncSupported(TrueFalseType), Webapp30Package.getFilterType_AsyncSupported()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='async-supported' namespace='http://java.sun.com/xml/ns/javaee'"

setAsyncSupported

void setAsyncSupported(TrueFalseType value)
Sets the value of the 'Async Supported' containment reference.

Parameters:
value - the new value of the 'Async Supported' containment reference.
See Also:
getAsyncSupported()
Generated:

getInitParam

 getInitParam()
Returns the value of the 'Init Param' containment reference list. The list contents are of type ParamValueType. The init-param element contains a name/value pair as an initialization param of a servlet filter

Returns:
the value of the 'Init Param' containment reference list.
See Also:
Webapp30Package.getFilterType_InitParam()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='init-param' namespace='http://java.sun.com/xml/ns/javaee'"

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp30Package.getFilterType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: