Package com.inductiveautomation.ignition.common.tags.rpc

Interface TagProviderRpc

public interface TagProviderRpc

Method Summary

Modifier and Type	Method	Description
Results<NodeDescription>	browse(TagPath tagPath, BrowseFilter filter)
Results<Result>	browseHistoricalTags(QualifiedPath root, BrowseFilter filter)
Results<BrowseElement>	browseTagDataSources(String provider, BrowseElement root, BrowseFilter filter)
void	cancelOpcImport(TagPath folderPath, CollisionPolicy policy, List<BrowseElement> elements)
void	cancelOpcTransfer(String source, List<BrowseElement> elements)
void	cancelSubscription()
boolean	canEditProvider(String providerName)
void	copyTagsToClipboard(List<TagPath> tagPaths, boolean removeOriginalTags)
Results<NodeDescription>	creatorBrowse(String providerName, String importSession, TagPath path, boolean single)
PropertySet	creatorModify(String providerName, String importSession, PropertySet changes)
QualityCode	deleteAllTagReferences(String providerName)
QualityCode	deleteTagReferences(TagPath path, Long afterTime, Long beforeTime)
List<TagProviderProps>	getAllProperties()
String	getElementTreeJson(String source, List<BrowseElement> elements)
int	getImportOpcCount(TagPath folderPath, CollisionPolicy policy, List<BrowseElement> elements)
int	getOpcTransferCount(String source, List<BrowseElement> elements)
TagProviderProps	getProperties(String providerName)
TagProviderInformation	getStatusInformation(String providerName)
ConfigurationPropertyModel	getTagConfigModel(String providerName)
List<TagConfigurationModel>	getTagConfigs(List<TagPath> tagPaths, boolean recursive)
TagDiagnostics	getTagDiagnostics(TagPath path)
String	getTagExport(List<TagPath> tagPaths, boolean recursive, String exportType)
ConfigurationPropertyModel	getTagGroupConfigModel(String provider)
List<TagGroupConfiguration>	getTagGroups(String providerName)
List<String>	getTagProviders()
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()
void	importReferenceTags(TagPath folderPath, CollisionPolicy policy, List<BrowseElement> elements)
List<QualityCode>	importTags(TagPath tagPath, String importText, String importType, CollisionPolicy policy)
long	manageSubscriptions(List<TagPath> tagPaths, boolean isRemove, boolean isFullDefinition)
List<QualityCode>	moveTags(List<TagPath> tagPaths, TagPath destination, Boolean copy, CollisionPolicy collisionPolicy)
List<QualityCode>	pasteFromClipboard(TagPath destination)
Results<NodeDescription>	query(String providerName, TagQueryFilter queryFilter)
List<Annotation>	queryAnnotations(List<Path> paths, Date start, Date end, TypeFilter filter)
List<QualifiedValue>	read(List<TagPath> tagPaths)
List<QualityCode>	reinitializeTags(List<TagPath> tagPaths)
List<QualityCode>	removeTagConfigs(List<TagPath> tagPaths)
List<QualityCode>	removeTagGroups(String providerName, List<String> tagGroupNames)
QualityCode	renameTag(TagPath tagPath, String newName, CollisionPolicy collisionPolicy)
void	requestTagGroupExecution(String providerName, String tagGroup)
List<QualityCode>	saveTagConfigs(String providerName, List<TagConfiguration> tagEdits, CollisionPolicy collisionPolicy)
List<QualityCode>	saveTagGroups(String providerName, List<TagGroupConfiguration> tagGroups)
List<QualifiedValue>	storeAnnotations(List<Annotation> annotations)
void	storeTagHistory(org.python.core.PyObject[] pyArgs, String[] keywords)
Results<com.inductiveautomation.ignition.common.tags.query.TagReportSearch>	updateTagReportSearch(com.inductiveautomation.ignition.common.tags.query.TagReportSearch search, boolean delete)
List<QualityCode>	write(List<TagPath> tagPaths, List<Object> values)

Method Details

browse

Results<NodeDescription> browse(TagPath tagPath,
 BrowseFilter filter)

query

Results<NodeDescription> query(String providerName,
 TagQueryFilter queryFilter)
                        throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

read

List<QualifiedValue> read(List<TagPath> tagPaths)
                   throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

write

List<QualityCode> write(List<TagPath> tagPaths,
 List<Object> values)

getTagConfigs

List<TagConfigurationModel> getTagConfigs(List<TagPath> tagPaths,
 boolean recursive)
                                   throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

copyTagsToClipboard

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

pasteFromClipboard

List<QualityCode> pasteFromClipboard(TagPath destination)

saveTagConfigs

List<QualityCode> saveTagConfigs(String providerName,
 List<TagConfiguration> tagEdits,
 CollisionPolicy collisionPolicy)
                          throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

moveTags

List<QualityCode> moveTags(List<TagPath> tagPaths,
 TagPath destination,
 Boolean copy,
 CollisionPolicy collisionPolicy)
                    throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

renameTag

QualityCode renameTag(TagPath tagPath,
 String newName,
 CollisionPolicy collisionPolicy)
               throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

removeTagConfigs

List<QualityCode> removeTagConfigs(List<TagPath> tagPaths)
                            throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

reinitializeTags

List<QualityCode> reinitializeTags(List<TagPath> tagPaths)
                            throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getTagGroups

List<TagGroupConfiguration> getTagGroups(String providerName)
                                  throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

saveTagGroups

List<QualityCode> saveTagGroups(String providerName,
 List<TagGroupConfiguration> tagGroups)
                         throws Exception

Throws:

Exception

removeTagGroups

List<QualityCode> removeTagGroups(String providerName,
 List<String> tagGroupNames)
                           throws Exception

Throws:

Exception

getProperties

TagProviderProps getProperties(String providerName)
                        throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getAllProperties

List<TagProviderProps> getAllProperties()

getTagDiagnostics

TagDiagnostics getTagDiagnostics(TagPath path)
                          throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getStatusInformation

TagProviderInformation getStatusInformation(String providerName)
                                     throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getTagConfigModel

ConfigurationPropertyModel getTagConfigModel(String providerName)
                                      throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getTagGroupConfigModel

ConfigurationPropertyModel getTagGroupConfigModel(String provider)
                                           throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

importTags

List<QualityCode> importTags(TagPath tagPath,
 String importText,
 String importType,
 CollisionPolicy policy)
                      throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getTagExport

String getTagExport(List<TagPath> tagPaths,
 boolean recursive,
 String exportType)
             throws Exception

Throws:

Exception

creatorBrowse

Results<NodeDescription> creatorBrowse(String providerName,
 String importSession,
 TagPath path,
 boolean single)
                                throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

creatorModify

PropertySet creatorModify(String providerName,
 String importSession,
 PropertySet changes)
                   throws ExecutionException,
InterruptedException,
UnsupportedOperationException

Throws:

ExecutionException

InterruptedException

UnsupportedOperationException

manageSubscriptions

long manageSubscriptions(List<TagPath> tagPaths,
 boolean isRemove,
 boolean isFullDefinition)

cancelSubscription

void cancelSubscription()

canEditProvider

boolean canEditProvider(String providerName)
                 throws Exception

Throws:

Exception

browseTagDataSources

Results<BrowseElement> browseTagDataSources(String provider,
 BrowseElement root,
 BrowseFilter filter)
                                     throws Exception

Throws:

Exception

importReferenceTags

void importReferenceTags(TagPath folderPath,
 CollisionPolicy policy,
 List<BrowseElement> elements)
                  throws Exception

Throws:

Exception

requestTagGroupExecution

void requestTagGroupExecution(String providerName,
 String tagGroup)
                       throws Exception

Throws:

Exception

storeTagHistory

void storeTagHistory(org.python.core.PyObject[] pyArgs,
 String[] keywords)
              throws Exception

Throws:

Exception

storeAnnotations

List<QualifiedValue> storeAnnotations(List<Annotation> annotations)

queryAnnotations

List<Annotation> queryAnnotations(List<Path> paths,
 Date start,
 Date end,
 TypeFilter filter)

getImportOpcCount

int getImportOpcCount(TagPath folderPath,
 CollisionPolicy policy,
 List<BrowseElement> elements)
               throws Exception

Throws:

Exception

getOpcTransferCount

int getOpcTransferCount(String source,
 List<BrowseElement> elements)

cancelOpcTransfer

void cancelOpcTransfer(String source,
 List<BrowseElement> elements)

cancelOpcImport

void cancelOpcImport(TagPath folderPath,
 CollisionPolicy policy,
 List<BrowseElement> elements)

getElementTreeJson

@Nullable
String getElementTreeJson(String source,
 List<BrowseElement> elements)
                   throws Exception

Throws:

Exception

getTagProviders

List<String> getTagProviders()

Returns:

A mutable, serializable list of tag providers.

browseHistoricalTags

Results<Result> browseHistoricalTags(QualifiedPath root,
 BrowseFilter 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)

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)

deleteAllTagReferences

QualityCode deleteAllTagReferences(String providerName)