Package com.seeq.model
Class CalculatedItemOutputV1
java.lang.Object
com.seeq.model.CalculatedItemOutputV1
CalculatedItemOutputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addParametersItem
(FormulaParameterOutputV1 parametersItem) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) effectivePermissions
(PermissionsV1 effectivePermissions) boolean
Additional properties of the itemThe data ID of this asset.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 itemGet effectivePermissionsThe formula for the calculated itemgetId()
The ID that can be used to interact with the itemWhether item is archivedWhether item is redactedgetName()
The human readable nameThe name of the package that contains this function.Parameters that are used in the context of executing the formulaTrue if permissions are managed by the datasource, false if they are managed in SeeqThe ID of the workbook to which this item is scoped or null if it is in the global scope.Security string in Seeq format provided by datasourceThe security string as it was originally found on the source (for debugging ACLs only)A plain language status message with information about any issues that may have been encountered during an operationThe item's translation key, if anygetType()
The type of the itemint
hashCode()
isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) packageName
(String packageName) parameters
(List<FormulaParameterOutputV1> parameters) permissionsFromDatasource
(Boolean permissionsFromDatasource) securityString
(String securityString) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDescription
(String description) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
setFormula
(String formula) void
void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
void
setPackageName
(String packageName) void
setParameters
(List<FormulaParameterOutputV1> parameters) void
setPermissionsFromDatasource
(Boolean permissionsFromDatasource) void
setScopedTo
(String scopedTo) void
setSecurityString
(String securityString) void
setSourceSecurityString
(String sourceSecurityString) void
setStatusMessage
(String statusMessage) void
setTranslationKey
(String translationKey) void
sourceSecurityString
(String sourceSecurityString) statusMessage
(String statusMessage) toString()
translationKey
(String translationKey)
-
Constructor Details
-
CalculatedItemOutputV1
public CalculatedItemOutputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
public CalculatedItemOutputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem) -
getAdditionalProperties
Additional properties of the item- Returns:
- additionalProperties
-
setAdditionalProperties
-
dataId
-
getDataId
The data ID of this asset. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.- Returns:
- dataId
-
setDataId
-
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
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
formula
-
getFormula
The formula for the calculated item- Returns:
- formula
-
setFormula
-
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
-
packageName
-
getPackageName
The name of the package that contains this function.- Returns:
- packageName
-
setPackageName
-
parameters
-
addParametersItem
-
getParameters
Parameters that are used in the context of executing the formula- Returns:
- parameters
-
setParameters
-
permissionsFromDatasource
-
getPermissionsFromDatasource
True if permissions are managed by the datasource, false if they are managed in Seeq- Returns:
- permissionsFromDatasource
-
setPermissionsFromDatasource
-
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
-
securityString
-
getSecurityString
Security string in Seeq format provided by datasource- Returns:
- securityString
-
setSecurityString
-
sourceSecurityString
-
getSourceSecurityString
The security string as it was originally found on the source (for debugging ACLs only)- Returns:
- sourceSecurityString
-
setSourceSecurityString
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
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
-