Interface AdvancedSearchModel

All Known Implementing Classes:
AbstractAdvancedSearchModel, DefaultAdvancedSearchModel

public interface AdvancedSearchModel
An AdvancedSearchModel holds information about which search fields are available, visible, sortable etc. It is ment to act as view model for view components which represent an advanced search mask.
  • Method Details

    • getParameterContainer

      AdvancedSearchParameterContainer getParameterContainer()
    • getRootSearchFieldGroup

      SearchFieldGroup getRootSearchFieldGroup()
      Returns the root search field group.
      Returns:
      the root group containing search fields and other groups in a hierarchical structure.
    • getSelectedType

      ObjectTemplate getSelectedType()
      Returns the currently selected type i.e. the type of the items which are being searched for.
      Returns:
      the active type
    • getTypes

      List<ObjectTemplate> getTypes()
      Returns all the types supported by this advanced search.
      Returns:
      list containing all the available search types
    • getSearchFields

      List<SearchField> getSearchFields()
      Returns all the available search fields.
      Returns:
      all the available search fields
      See Also:
    • getVisibleSearchFields

      List<SearchField> getVisibleSearchFields()
      Returns all the available visible search fields.
      Returns:
      all the available search fields which are currently visible
      See Also:
    • getHiddenSearchFields

      List<SearchField> getHiddenSearchFields()
      Returns all the available hidden search fields.
      Returns:
      all the available search fields which are currently hidden
      See Also:
    • getSortableProperties

      List<PropertyDescriptor> getSortableProperties()
      Returns all the properties which can currently be used for sorting.
      Returns:
      all the available properties which can be used for sorting
    • getSortedByProperty

      PropertyDescriptor getSortedByProperty()
      Returns the property by which search result should be sorted.
      Returns:
      the property to be used for sorting
    • isSortAscending

      boolean isSortAscending()
      Returns whether search result is sorted ascending or not.
      Returns:
      true if ascending, false if descending
    • getEditor

      UIEditor getEditor(SearchField searchField)
      Returns the editor for a specific search field.
      Parameters:
      searchField - the search field, for which the corresponding editor is to be returned
      Returns:
      the editor corresponding to the specified search field
    • getPropertyDescriptor

      PropertyDescriptor getPropertyDescriptor(SearchField field)
    • resetToInitialSearchParameters

      void resetToInitialSearchParameters()
      Method cleans search fields and sets type as rootType
    • getParametersForSearchField

      Map<String,String> getParametersForSearchField(SearchField searchField)
      Returns:
      parameters for search field