com.sas.services.information.search
Interface SearchFilter

All Known Implementing Classes:
DateFilter, DisplayNameFilter, ExtendedAttributesFilter, KeywordFilter, NotesFilter, ObjectNameFilter, PublicTypeFilter, ResponsibilitiesFilter

public interface SearchFilter

The filters used to scope a search, implement the SearchFilter interface.


Method Summary
 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.
 

Method Detail

getFilterComponent

FilterComponent getFilterComponent()
Returns the filter component used for processing this search criteria

Returns:
filter component

getFilterType

java.lang.String getFilterType()
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.

Returns:
filter type

getFilterDescription

java.lang.String getFilterDescription()
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.

Returns:
the filter description



Copyright © 2009 SAS Institute Inc. All Rights Reserved.