Package com.seeq.model
Class DisplayTemplateOutputV1
java.lang.Object
com.seeq.model.DisplayTemplateOutputV1
DisplayTemplateOutputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondatasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) displayCount
(Integer displayCount) effectivePermissions
(PermissionsV1 effectivePermissions) boolean
The datasource class, which is the type of system holding the item, such as OSIsoft PIThe datasource identifier, which is how the datasource holding this item identifies itselfClarifying information or other plain language description of this itemThe number of displays modeled after the templateGet effectivePermissionsgetId()
The ID that can be used to interact with the itemWhether item is archivedWhether item is redactedgetName()
The human readable nameThe ID of the workbook to which this item is scoped or null if it is in the global scope.The ID of the source workstep for the display templateA plain language status message with information about any issues that may have been encountered during an operationThe asset to swap out when loading displays based on this templateThe item's translation key, if anygetType()
The type of the itemint
hashCode()
isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDescription
(String description) void
setDisplayCount
(Integer displayCount) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
void
setScopedTo
(UUID scopedTo) void
setSourceWorkstepId
(UUID sourceWorkstepId) void
setStatusMessage
(String statusMessage) void
setSwapSourceAssetId
(UUID swapSourceAssetId) void
setTranslationKey
(String translationKey) void
sourceWorkstepId
(UUID sourceWorkstepId) statusMessage
(String statusMessage) swapSourceAssetId
(UUID swapSourceAssetId) toString()
translationKey
(String translationKey)
-
Constructor Details
-
DisplayTemplateOutputV1
public DisplayTemplateOutputV1()
-
-
Method Details
-
datasourceClass
-
getDatasourceClass
The datasource class, which is the type of system holding the item, such as OSIsoft PI- Returns:
- datasourceClass
-
setDatasourceClass
-
datasourceId
-
getDatasourceId
The datasource identifier, which is how the datasource holding this item identifies itself- Returns:
- datasourceId
-
setDatasourceId
-
description
-
getDescription
Clarifying information or other plain language description of this item- Returns:
- description
-
setDescription
-
displayCount
-
getDisplayCount
The number of displays modeled after the template- Returns:
- displayCount
-
setDisplayCount
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
name
-
getName
The human readable name- Returns:
- name
-
setName
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item is scoped or null if it is in the global scope.- Returns:
- scopedTo
-
setScopedTo
-
sourceWorkstepId
-
getSourceWorkstepId
The ID of the source workstep for the display template- Returns:
- sourceWorkstepId
-
setSourceWorkstepId
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
swapSourceAssetId
-
getSwapSourceAssetId
The asset to swap out when loading displays based on this template- Returns:
- swapSourceAssetId
-
setSwapSourceAssetId
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
equals
-
hashCode
public int hashCode() -
toString
-