com.sas.services.information.search
Class NotesFilter

com.sas.services.information.search.NotesFilter

All Implemented Interfaces:

SearchFilter, java.io.Serializable

public class NotesFilter
implements SearchFilter, java.io.Serializable

The NotesFilter class is used to filter or search for objects by their associated notes. This includes both private notes (such as quick notes) and associated public (or shared) notes.

See Also:

Serialized Form

Field Summary

protected java.util.List<java.lang.String>	_notes
protected static java.lang.String	ATTRIBUTE_PUBLICTYPE
protected static java.lang.String	ATTRIBUTE_STOREDTEXT
protected static java.lang.String	ATTRIBUTE_TEXTROLE
protected static java.lang.String	DOCUMENTS_ASSOCIATION_NAME
protected static java.lang.String	DOCUMENTS_ASSOCIATION_TYPE
protected static java.lang.String	NOTES_ASSOCIATION_NAME
protected static java.lang.String	NOTES_ASSOCIATION_TYPE

Constructor Summary

NotesFilter(java.util.List<java.lang.String> notes)
Constructs a new notes filter that allows objects to be searched their associated notes.

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>	getNotes() Returns the notes being searched for

Field Detail

DOCUMENTS_ASSOCIATION_NAME

protected static final java.lang.String DOCUMENTS_ASSOCIATION_NAME

See Also:

Constant Field Values

DOCUMENTS_ASSOCIATION_TYPE

protected static final java.lang.String DOCUMENTS_ASSOCIATION_TYPE

See Also:

Constant Field Values

NOTES_ASSOCIATION_NAME

protected static final java.lang.String NOTES_ASSOCIATION_NAME

See Also:

Constant Field Values

NOTES_ASSOCIATION_TYPE

protected static final java.lang.String NOTES_ASSOCIATION_TYPE

See Also:

Constant Field Values

ATTRIBUTE_STOREDTEXT

protected static final java.lang.String ATTRIBUTE_STOREDTEXT

See Also:

Constant Field Values

ATTRIBUTE_PUBLICTYPE

protected static final java.lang.String ATTRIBUTE_PUBLICTYPE

See Also:

Constant Field Values

ATTRIBUTE_TEXTROLE

protected static final java.lang.String ATTRIBUTE_TEXTROLE

See Also:

Constant Field Values

_notes

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

Constructor Detail

NotesFilter

public NotesFilter(java.util.List<java.lang.String> notes)

Constructs a new notes filter that allows objects to be searched their associated notes.

Parameters:

text - the note text to search on

Method Detail

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

getNotes

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

Returns the notes being searched for

Returns:

notes

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