Package com.inductiveautomation.ignition.common.search

Class SearchReplacement

java.lang.Object

com.inductiveautomation.ignition.common.search.SearchReplacement

All Implemented Interfaces:

Serializable

public class SearchReplacement
extends Object
implements Serializable

Send back to the gateway to run a string replacement on an item. The SearchResult implemementation must contain enough internal information to allow the specified search provider to be able to locate and update the search result String with the replacement.

Since:

8.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SearchReplacement()
SearchReplacement(SearchResult result, String replacementText)

Method Summary

Modifier and Type	Method	Description
String	getReplacementText()	The string that will replace the original string.
String	getSearchProvider()	The search provider that should handle this replacement
SearchResult	getSearchResult()	The original SearchResult that was retrieved during a previous search.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchReplacement

public SearchReplacement()

SearchReplacement

public SearchReplacement(SearchResult result,
 String replacementText)

Method Details

getSearchResult

public SearchResult getSearchResult()

The original SearchResult that was retrieved during a previous search.

getReplacementText

public String getReplacementText()

The string that will replace the original string.

getSearchProvider

public String getSearchProvider()

The search provider that should handle this replacement