Class SearchReplacement
- java.lang.Object
-
- com.inductiveautomation.ignition.common.search.SearchReplacement
-
- All Implemented Interfaces:
java.io.Serializable
public class SearchReplacement extends java.lang.Object implements java.io.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, java.lang.String replacementText)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getReplacementText()
The string that will replace the original string.java.lang.String
getSearchProvider()
The search provider that should handle this replacementSearchResult
getSearchResult()
The original SearchResult that was retrieved during a previous search.
-
-
-
Constructor Detail
-
SearchReplacement
public SearchReplacement()
-
SearchReplacement
public SearchReplacement(SearchResult result, java.lang.String replacementText)
-
-
Method Detail
-
getSearchResult
public SearchResult getSearchResult()
The original SearchResult that was retrieved during a previous search.
-
getReplacementText
public java.lang.String getReplacementText()
The string that will replace the original string.
-
getSearchProvider
public java.lang.String getSearchProvider()
The search provider that should handle this replacement
-
-