Package wt.filter

Class FilterArguments

java.lang.Object

wt.filter.FilterArguments

All Implemented Interfaces:

Serializable

public class FilterArguments
extends Object
implements Serializable

Object used for passing the information about the filterable objects as argument to the filtering service

Supported API: true

Extendable: true

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getDelegateData()	Gets the filter delegate data Map.
Object	getDelegateData(String delegateClassName)	Get the filter-delegate-specific data.
Filterable	getFilterable()	Returns the filterable object.
List	getSupportingObjects()	Returns the collection of dependent objects for the filterable object.
void	setDelegateData(String delegateClassName, Object data)	Sets the filter-delegate-specific data.
void	setDelegateData(Map<String,Object> delegateData)	Sets the filter delegate data map.
void	setFilterable(Filterable filterable)	Sets the filterable object to be filtered.
void	setSupportingObjects(List supportingObjects)	Sets the collection of dependent objects for the filterable object.

Methods inherited from class java.lang.Object

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

Method Details

setFilterable

public void setFilterable(Filterable filterable)

Sets the filterable object to be filtered.
Supported API: true

Parameters:

filterable - the filterable object.

getFilterable

public Filterable getFilterable()

Returns the filterable object.
Supported API: true

Returns:

the filterable object.

setSupportingObjects

public void setSupportingObjects(List supportingObjects)

Sets the collection of dependent objects for the filterable object.
Supported API: true

Parameters:

supportingObjects - the dependent object.

getSupportingObjects

public List getSupportingObjects()

Returns the collection of dependent objects for the filterable object.
Supported API: true

Returns:

the collection dependent object.

setDelegateData

public void setDelegateData(String delegateClassName,
 Object data)

Sets the filter-delegate-specific data. It is expected that NavigationFilterDelegates will call this setter. The purpose of the delegateData is so that a delegate can save some state information from one invokation to an invokation on a child.
Supported API: true

Parameters:

delegateClassName - The name of the delegate class that is setting the data.

data - The data being set.

getDelegateData

public Object getDelegateData(String delegateClassName)

Get the filter-delegate-specific data.
Supported API: true

Parameters:

delegateClassName - The name of the delegate class that is setting the data.

Returns:

The filter-delegate-specific data.

getDelegateData

public Map<String,Object> getDelegateData()

Gets the filter delegate data Map.
Supported API: true

Returns:

The filter delegate data Map.

setDelegateData

public void setDelegateData(Map<String,Object> delegateData)

Sets the filter delegate data map.
Supported API: true

Parameters:

delegateData - The filter delegate data map.