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

    Modifier and Type
    Method
    Description
    Returns the filter component used for processing this search criteria
    String
    Returns the description of this filter.
    String
    Returns the localized name of this filter.
  • Method Details

    • getFilterComponent

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

      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

      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