com.inductiveautomation.ignition.common.search

Class BasicSearchParameters

java.lang.Object

com.inductiveautomation.ignition.common.search.BasicSearchParameters

All Implemented Interfaces:

SearchParameters, java.io.Serializable

public class BasicSearchParameters
extends java.lang.Object
implements SearchParameters, java.io.Serializable

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicSearchParameters(java.util.Map<java.lang.String,Filter<?>> searchProviders, java.lang.String searchPredicate, boolean searchImmutableItems)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,Filter<?>>	getSearchFilters() The names of the search providers that should process the search request.
java.lang.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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicSearchParameters

public BasicSearchParameters(java.util.Map<java.lang.String,Filter<?>> searchProviders,
                             java.lang.String searchPredicate,
                             boolean searchImmutableItems)

Method Detail

getSearchFilters

public java.util.Map<java.lang.String,Filter<?>> getSearchFilters()

Description copied from interface: SearchParameters

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.

Specified by:

getSearchFilters in interface SearchParameters

searchImmutableItems

public boolean searchImmutableItems()

Description copied from interface: SearchParameters

Set to True to return immutable items in the search results

Specified by:

searchImmutableItems in interface SearchParameters

getSearchPredicate

public java.lang.String getSearchPredicate()

Description copied from interface: SearchParameters

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

Specified by:

getSearchPredicate in interface SearchParameters