com.sas.services.information.search
Class KeywordFilter

com.sas.services.information.search.KeywordFilter

All Implemented Interfaces:

SearchFilter, java.io.Serializable

public class KeywordFilter
implements SearchFilter, java.io.Serializable

The KeywordFilter class is used to filter objects by their associated keywords. For instance, an application may need to display only those objects with the associated keywords.

See Also:

Serialized Form

Field Summary

protected java.util.List<java.lang.String>	_keywords
protected static java.lang.String	ASSOCIATION_NAME
protected static java.lang.String	ASSOCIATION_TYPE
protected static java.lang.String	KEYWORD_NAME

Constructor Summary

KeywordFilter(java.util.List<java.lang.String> keywords)

Method Summary

boolean	equals(java.lang.Object obj)
FilterComponent	getFilterComponent() Returns the filter component used for processing this search criteria
java.lang.String	getFilterDescription() Returns the description of this filter.
java.lang.String	getFilterType() Returns the localized name of this filter.
java.util.List<java.lang.String>	getKeywords()

Field Detail

KEYWORD_NAME

protected static final java.lang.String KEYWORD_NAME

See Also:

Constant Field Values

ASSOCIATION_NAME

protected static final java.lang.String ASSOCIATION_NAME

See Also:

Constant Field Values

ASSOCIATION_TYPE

protected static final java.lang.String ASSOCIATION_TYPE

See Also:

Constant Field Values

_keywords

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

Constructor Detail

KeywordFilter

public KeywordFilter(java.util.List<java.lang.String> keywords)

Method Detail

getKeywords

public java.util.List<java.lang.String> getKeywords()

getFilterType

public java.lang.String getFilterType()

Description copied from interface: SearchFilter

Returns the localized name of this filter. This method is typically used to help identify to the user what type of search is being performed. For instance, a name search, or a type search.

Specified by:

getFilterType in interface SearchFilter

Returns:

filter type

getFilterDescription

public java.lang.String getFilterDescription()

Description copied from interface: SearchFilter

Returns the description of this filter. This description is typically used for display purposes, or a log file, to inform the user what the intention of this filter is.

Specified by:

getFilterDescription in interface SearchFilter

Returns:

the filter description

getFilterComponent

public FilterComponent getFilterComponent()

Description copied from interface: SearchFilter

Returns the filter component used for processing this search criteria

Specified by:

getFilterComponent in interface SearchFilter

Returns:

filter component

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object