Package com.inductiveautomation.ignition.client.tags.model

Interface ClientTagManager

All Superinterfaces:

TagManager

All Known Implementing Classes:

ClientTagManagerImpl, DesignerTagManagerImpl

public interface ClientTagManager
extends TagManager

Since:

8.0

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager

BROWSE_LOCAL_SYSTEM, DATA_SOURCE_OPC

Method Summary

Modifier and Type	Method	Description
void	addClientTagProvider(ClientTagProvider provider)
default CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter browseFilter, SecurityContext securityContext)
CompletableFuture<Results<Result>>	browseHistoricalTagsAsync(QualifiedPath root, BrowseFilter filter)
void	copyTagsToClipboard(List<TagPath> tagPaths, boolean removeOriginalTags)
CompletableFuture<Results<NodeDescription>>	creatorBrowse(String provider, String session, TagPath path, boolean single)
CompletableFuture<PropertySet>	creatorModify(String provider, String session, PropertySet changes)
QualityCode	deleteAllTagReference(String providerName)
QualityCode	deleteTagReferences(TagPath path, Long afterTime, Long beforeTime)
TagAttributeManager	getAttributeManager()
ClientTagProvider	getClientTagProvider(String provider)
ClientTagProvider	getDefaultProvider()
StatMetric	getPollingMetric()
List<TagProviderProps>	getProviderProperties()
TagProviderProps	getProviderProperties(String provider)
SystemTagManager	getSystemTagManager()
CompletableFuture<List<TagConfigurationModel>>	getTagConfigsAsync(List<TagPath> tagPaths, boolean recursive, boolean localPropsOnly)
Results<com.inductiveautomation.ignition.common.tags.config.model.TagReference>	getTagReferences(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery query)
Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch>	getTagReportSearches()
UdtDefinitionInfo	getTypeDefinition(TagPath typeId)
Map<TagPath,UdtDefinitionInfo>	getTypeDefinitions(List<TagPath> typeIds)
StatMetric	getValueChangeMetric()
CompletableFuture<QualityCode>	importTagDataSourcesAsync(TagPath location, List<BrowseElement> elements)
default CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy collisionPolicy, SecurityContext securityContext)
boolean	isAncestorOf(TagPath baseTypeId, TagPath potentialSubTypeId)	Returns true if the second argument is equal to or subtype of the first argument.
CompletableFuture<List<QualityCode>>	pasteFromClipboard(TagPath destination)
Results<NodeDescription>	query(String provider, TagQueryFilter filter)
CompletableFuture<List<QualityCode>>	reinitializeTagsAsync(List<TagPath> tagPaths)
CompletableFuture<List<QualityCode>>	removeTagsAsync(List<TagPath> tagPaths, SecurityContext securityContext)
default CompletableFuture<QualityCode>	renameTagAsync(TagPath tag, String newName, CollisionPolicy collisionPolicy)
CompletableFuture<QualityCode>	renameTagAsync(TagPath tag, String newName, CollisionPolicy collisionPolicy, SecurityContext securityContext)
void	requestTagGroupExecution(String provider, String tagGroup)
CompletableFuture<List<QualityCode>>	saveTagConfigsAsync(List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy, SecurityContext securityContext)
Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch>	updateTagReportSearch(com.inductiveautomation.ignition.common.tags.query.TagReportSearch search, boolean delete)

Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager

browseAsync, browseTagDataSourcesAsync, getDiagnosticsAsync, getTagConfigModelAsync, getTagGroupConfigModelAsync, getTagGroupsAsync, importTagsAsync, moveTagsAsync, moveTagsAsync, readAsync, readAsync, reinitializeTags, subscribeAsync, subscribeAsync, unsubscribeAsync, unsubscribeAsync, writeAsync, writeAsync

Method Details

addClientTagProvider

void addClientTagProvider(ClientTagProvider provider)

getClientTagProvider

ClientTagProvider getClientTagProvider(String provider)

getProviderProperties

List<TagProviderProps> getProviderProperties()

getDefaultProvider

ClientTagProvider getDefaultProvider()

getProviderProperties

TagProviderProps getProviderProperties(String provider)

getTypeDefinition

UdtDefinitionInfo getTypeDefinition(TagPath typeId)

getTypeDefinitions

Map<TagPath,UdtDefinitionInfo> getTypeDefinitions(List<TagPath> typeIds)
                                           throws Exception

Throws:

Exception

isAncestorOf

boolean isAncestorOf(TagPath baseTypeId,
 TagPath potentialSubTypeId)

Returns true if the second argument is equal to or subtype of the first argument.

requestTagGroupExecution

void requestTagGroupExecution(String provider,
 String tagGroup)
                       throws Exception

Throws:

Exception

copyTagsToClipboard

void copyTagsToClipboard(List<TagPath> tagPaths,
 boolean removeOriginalTags)

pasteFromClipboard

CompletableFuture<List<QualityCode>> pasteFromClipboard(TagPath destination)

getTagConfigsAsync

CompletableFuture<List<TagConfigurationModel>> getTagConfigsAsync(List<TagPath> tagPaths,
 boolean recursive,
 boolean localPropsOnly)

saveTagConfigsAsync

CompletableFuture<List<QualityCode>> saveTagConfigsAsync(List<TagConfiguration> tagEdits,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

removeTagsAsync

CompletableFuture<List<QualityCode>> removeTagsAsync(List<TagPath> tagPaths,
 SecurityContext securityContext)

importTagDataSourcesAsync

CompletableFuture<QualityCode> importTagDataSourcesAsync(TagPath location,
 List<BrowseElement> elements)

browseHistoricalTagsAsync

CompletableFuture<Results<Result>> browseHistoricalTagsAsync(QualifiedPath root,
 BrowseFilter filter)

getAttributeManager

TagAttributeManager getAttributeManager()

reinitializeTagsAsync

CompletableFuture<List<QualityCode>> reinitializeTagsAsync(List<TagPath> tagPaths)

getSystemTagManager

SystemTagManager getSystemTagManager()

getPollingMetric

StatMetric getPollingMetric()

getValueChangeMetric

StatMetric getValueChangeMetric()

renameTagAsync

CompletableFuture<QualityCode> renameTagAsync(TagPath tag,
 String newName,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

renameTagAsync

default CompletableFuture<QualityCode> renameTagAsync(TagPath tag,
 String newName,
 CollisionPolicy collisionPolicy)

browseAsync

default CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
 BrowseFilter browseFilter,
 SecurityContext securityContext)

Specified by:

browseAsync in interface TagManager

query

Results<NodeDescription> query(String provider,
 TagQueryFilter filter)

getTagReportSearches

Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch> getTagReportSearches()

updateTagReportSearch

Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch> updateTagReportSearch(com.inductiveautomation.ignition.common.tags.query.TagReportSearch search,
 boolean delete)

importTagsAsync

default CompletableFuture<List<QualityCode>> importTagsAsync(TagPath basePath,
 String importText,
 String importType,
 CollisionPolicy collisionPolicy,
 SecurityContext securityContext)

Specified by:

importTagsAsync in interface TagManager

Parameters:

basePath - tags will be imported using this location as the base. The provider source must be set.

importText - a String holding the contents of the file to import

importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.

collisionPolicy - The collision policy to use. Abort will throw an exception on the first tag collision, Ignore will not change the existing tag at all, Overwrite will overwrite the existing tag completely, and Rename will create a new tag with a similar name (MyTag becomes MyTag1).

securityContext - the SecurityContext of the user from the call site

creatorBrowse

CompletableFuture<Results<NodeDescription>> creatorBrowse(String provider,
 String session,
 TagPath path,
 boolean single)

creatorModify

CompletableFuture<PropertySet> creatorModify(String provider,
 String session,
 PropertySet changes)

getTagReferences

Results<com.inductiveautomation.ignition.common.tags.config.model.TagReference> getTagReferences(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery query)

deleteTagReferences

QualityCode deleteTagReferences(TagPath path,
 Long afterTime,
 Long beforeTime)

deleteAllTagReference

QualityCode deleteAllTagReference(String providerName)