com.inductiveautomation.ignition.common.search

Interface SearchResult

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

TagSearchResult

public interface SearchResult
extends java.io.Serializable

A search result returned by a gateway search provider. Implementations must hold enough information to be able to send this object back to the gateway from a designer, and be able to apply any edits specified by the user in the designer.

Since:

8.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLocation() The name of the entity where this result is found.
java.lang.String	getName() The name of the object that matches the search pattern.
java.lang.String	getSearchProviderName() The name of the search provider that created this result.
java.lang.String	getText() Gets the text representation of the search result.
boolean	isMutable()

Method Detail

getSearchProviderName

java.lang.String getSearchProviderName()

The name of the search provider that created this result.

getLocation

java.lang.String getLocation()

The name of the entity where this result is found. Used in the results display to help distinguish similar items. For something like a tag property, the owner name is the path to the tag property

getName

java.lang.String getName()

The name of the object that matches the search pattern. In other words, a description of the element inside the owner, such as "Name", or "Expression". For something like a tag, the name is the tag property where the search pattern was found.

getText

java.lang.String getText()

Gets the text representation of the search result. This is what will be used for the "search".

isMutable

boolean isMutable()

Returns:

true if the returned item can be modified via a replace operation