Package com.inductiveautomation.ignition.common.search

Interface SearchParameters

All Superinterfaces:
Serializable
All Known Implementing Classes:
BasicSearchParameters
public interface SearchParameters extends Serializable
A search request that is to be sent to a gateway search provider.
Since:
8.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Filter<?>>
    getSearchFilters()
    The names of the search providers that should process the search request.
    String
    getSearchPredicate()
    This is ultimately the String that you are attempting to find via the Search/Replace dialog.
    boolean
    searchImmutableItems()
    Set to True to return immutable items in the search results

  • Method Details

    • searchImmutableItems

      boolean searchImmutableItems()
      Set to True to return immutable items in the search results

    • getSearchPredicate

      String getSearchPredicate()
      This is ultimately the String that you are attempting to find via the Search/Replace dialog. The Filter should be able to help to significantly cut down on the list, but each item must be text searched so that it can be returned as a SearchResult

    • getSearchFilters

      Map<String,Filter<?>> getSearchFilters()
      The names of the search providers that should process the search request. Each search provider must supply a Filter object, configured to search for items that the search provider knows how to locate.