Interface SearchService

All Known Implementing Classes:
DefaultSearchService

public interface SearchService
The interface SearchService. Provides functionality that can be used for preparing and performing search operations.
  • Method Details

    • getSearchType

      SearchType getSearchType(ObjectType objectType)
      Gets the search type for given object type. Argument can also be already a SearchType and in this case it should be just returned.
      Parameters:
      objectType - the object type to look search type for
      Returns:
      the search type found for the given argument
    • getSearchType

      SearchType getSearchType(ObjectTemplate objectTemplate)
      Gets the search type for the given object template.
      Parameters:
      objectTemplate - the object template to look search type for
      Returns:
      the search type found for the given object template
    • getSearchType

      SearchType getSearchType(String objectTemplateCode)
      Gets the search type for the given object template code.
      Parameters:
      objectTemplateCode - the object template code to look search type for
      Returns:
      the search type found for the given argument
    • isSortable

      boolean isSortable(PropertyDescriptor propDescr)
      Checks if given property is sortable, so it can later be used to sort by.
      Parameters:
      propDescr - the property descriptor to check for beeing sortable
      Returns:
      true, if the given property is sortable
    • getSearchDescriptor

      SearchParameterDescriptor getSearchDescriptor(PropertyDescriptor propDescr)
      Gets the search descriptor for the given property descriptor SearchParameterDescriptor contains the list of Operator objects.
      Parameters:
      propDescr - the property descriptor to create search parameter descriptor
      Returns:
      the search descriptor created on given property descriptor
    • getSearchDescriptor

      SearchParameterDescriptor getSearchDescriptor(PropertyDescriptor propertyDescriptor, boolean simpleSearch)
      Gets the search descriptor for the given property descriptor SearchParameterDescriptor contains the list of Operator objects.
      Parameters:
      propertyDescriptor - the property descriptor to create search parameter descriptor
      simpleSearch - the simple search attribute that will be set on the result object
      Returns:
      the search descriptor created on given arguments
    • getSearchProvider

      SearchProvider getSearchProvider()
      Gets the current search provider of the service implementation. Search provider exposes a functionality we can use to perform required search operations.
      Returns:
      the current search provider implementation