Class DisplayTemplateOutputV1

java.lang.Object
com.seeq.model.DisplayTemplateOutputV1

public class DisplayTemplateOutputV1 extends Object
DisplayTemplateOutputV1
  • Constructor Details

    • DisplayTemplateOutputV1

      public DisplayTemplateOutputV1()
  • Method Details

    • datasourceClass

      public DisplayTemplateOutputV1 datasourceClass(String datasourceClass)
    • getDatasourceClass

      public String getDatasourceClass()
      The datasource class, which is the type of system holding the item, such as OSIsoft PI
      Returns:
      datasourceClass
    • setDatasourceClass

      public void setDatasourceClass(String datasourceClass)
    • datasourceId

      public DisplayTemplateOutputV1 datasourceId(String datasourceId)
    • getDatasourceId

      public String getDatasourceId()
      The datasource identifier, which is how the datasource holding this item identifies itself
      Returns:
      datasourceId
    • setDatasourceId

      public void setDatasourceId(String datasourceId)
    • description

      public DisplayTemplateOutputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • displayCount

      public DisplayTemplateOutputV1 displayCount(Integer displayCount)
    • getDisplayCount

      public Integer getDisplayCount()
      The number of displays modeled after the template
      Returns:
      displayCount
    • setDisplayCount

      public void setDisplayCount(Integer displayCount)
    • effectivePermissions

      public DisplayTemplateOutputV1 effectivePermissions(PermissionsV1 effectivePermissions)
    • getEffectivePermissions

      public PermissionsV1 getEffectivePermissions()
      Get effectivePermissions
      Returns:
      effectivePermissions
    • setEffectivePermissions

      public void setEffectivePermissions(PermissionsV1 effectivePermissions)
    • id

    • getId

      public String getId()
      The ID that can be used to interact with the item
      Returns:
      id
    • setId

      public void setId(String id)
    • isArchived

      public DisplayTemplateOutputV1 isArchived(Boolean isArchived)
    • getIsArchived

      public Boolean getIsArchived()
      Whether item is archived
      Returns:
      isArchived
    • setIsArchived

      public void setIsArchived(Boolean isArchived)
    • isRedacted

      public DisplayTemplateOutputV1 isRedacted(Boolean isRedacted)
    • getIsRedacted

      public Boolean getIsRedacted()
      Whether item is redacted
      Returns:
      isRedacted
    • setIsRedacted

      public void setIsRedacted(Boolean isRedacted)
    • name

      public DisplayTemplateOutputV1 name(String name)
    • getName

      public String getName()
      The human readable name
      Returns:
      name
    • setName

      public void setName(String name)
    • scopedTo

      public DisplayTemplateOutputV1 scopedTo(UUID scopedTo)
    • getScopedTo

      public UUID getScopedTo()
      The ID of the workbook to which this item is scoped or null if it is in the global scope.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(UUID scopedTo)
    • sourceWorkstepId

      public DisplayTemplateOutputV1 sourceWorkstepId(UUID sourceWorkstepId)
    • getSourceWorkstepId

      public UUID getSourceWorkstepId()
      The ID of the source workstep for the display template
      Returns:
      sourceWorkstepId
    • setSourceWorkstepId

      public void setSourceWorkstepId(UUID sourceWorkstepId)
    • statusMessage

      public DisplayTemplateOutputV1 statusMessage(String statusMessage)
    • getStatusMessage

      public String getStatusMessage()
      A plain language status message with information about any issues that may have been encountered during an operation
      Returns:
      statusMessage
    • setStatusMessage

      public void setStatusMessage(String statusMessage)
    • swapSourceAssetId

      public DisplayTemplateOutputV1 swapSourceAssetId(UUID swapSourceAssetId)
    • getSwapSourceAssetId

      public UUID getSwapSourceAssetId()
      The asset to swap out when loading displays based on this template
      Returns:
      swapSourceAssetId
    • setSwapSourceAssetId

      public void setSwapSourceAssetId(UUID swapSourceAssetId)
    • translationKey

      public DisplayTemplateOutputV1 translationKey(String translationKey)
    • getTranslationKey

      public String getTranslationKey()
      The item's translation key, if any
      Returns:
      translationKey
    • setTranslationKey

      public void setTranslationKey(String translationKey)
    • type

      public DisplayTemplateOutputV1 type(String type)
    • getType

      public String getType()
      The type of the item
      Returns:
      type
    • setType

      public void setType(String type)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object