Package com.seeq.model
Class ItemSearchPreviewV1
java.lang.Object
com.seeq.model.ItemSearchPreviewV1
The list of items
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAncestorsItem
(ItemPreviewV1 ancestorsItem) addParametersItem
(FormulaParameterOutputV1 parametersItem) ancestors
(List<ItemPreviewV1> ancestors) datasource
(ItemPreviewV1 datasource) description
(String description) boolean
The list of ancestors in the asset tree, ordered with the root ancestor first, if the item is in an asset tree.Get datasourceThe description of the itemA boolean indicating whether or not child items exist for this item in the asset tree; the value will be true even if the child items are archived unless the tree for this item is deleted.getId()
The ID that can be used to interact with the itemItem properties mapped by name, corresponding to the properties requested for the search.Whether item is archivedTrue if the item belongs to an asset groupWhether item is redactedgetName()
The human readable nameGet parametersThe datasource's original, unparsed unit of measure for the values, if it existsThe item's translation key, if anygetType()
The type of the itemThe Seeq-recognized unit of measure for the values, if it existshasChildren
(Boolean hasChildren) int
hashCode()
includedProperties
(Map<String, ScalarPropertyV1> includedProperties) isArchived
(Boolean isArchived) isAssetGroupItem
(Boolean isAssetGroupItem) isRedacted
(Boolean isRedacted) parameters
(List<FormulaParameterOutputV1> parameters) putIncludedPropertiesItem
(String key, ScalarPropertyV1 includedPropertiesItem) void
setAncestors
(List<ItemPreviewV1> ancestors) void
setDatasource
(ItemPreviewV1 datasource) void
setDescription
(String description) void
setHasChildren
(Boolean hasChildren) void
void
setIncludedProperties
(Map<String, ScalarPropertyV1> includedProperties) void
setIsArchived
(Boolean isArchived) void
setIsAssetGroupItem
(Boolean isAssetGroupItem) void
setIsRedacted
(Boolean isRedacted) void
void
setParameters
(List<FormulaParameterOutputV1> parameters) void
setSourceValueUnitOfMeasure
(String sourceValueUnitOfMeasure) void
setTranslationKey
(String translationKey) void
void
setValueUnitOfMeasure
(String valueUnitOfMeasure) sourceValueUnitOfMeasure
(String sourceValueUnitOfMeasure) toString()
translationKey
(String translationKey) valueUnitOfMeasure
(String valueUnitOfMeasure)
-
Constructor Details
-
ItemSearchPreviewV1
public ItemSearchPreviewV1()
-
-
Method Details
-
ancestors
-
addAncestorsItem
-
getAncestors
The list of ancestors in the asset tree, ordered with the root ancestor first, if the item is in an asset tree. If an item is in more than one asset tree an arbitrary one will be chosen.- Returns:
- ancestors
-
setAncestors
-
datasource
-
getDatasource
Get datasource- Returns:
- datasource
-
setDatasource
-
description
-
getDescription
The description of the item- Returns:
- description
-
setDescription
-
hasChildren
-
getHasChildren
A boolean indicating whether or not child items exist for this item in the asset tree; the value will be true even if the child items are archived unless the tree for this item is deleted.- Returns:
- hasChildren
-
setHasChildren
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
includedProperties
-
putIncludedPropertiesItem
public ItemSearchPreviewV1 putIncludedPropertiesItem(String key, ScalarPropertyV1 includedPropertiesItem) -
getIncludedProperties
Item properties mapped by name, corresponding to the properties requested for the search. Note that this will be empty if no properties were requested.- Returns:
- includedProperties
-
setIncludedProperties
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isAssetGroupItem
-
getIsAssetGroupItem
True if the item belongs to an asset group- Returns:
- isAssetGroupItem
-
setIsAssetGroupItem
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
name
-
getName
The human readable name- Returns:
- name
-
setName
-
parameters
-
addParametersItem
-
getParameters
Get parameters- Returns:
- parameters
-
setParameters
-
sourceValueUnitOfMeasure
-
getSourceValueUnitOfMeasure
The datasource's original, unparsed unit of measure for the values, if it exists- Returns:
- sourceValueUnitOfMeasure
-
setSourceValueUnitOfMeasure
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
valueUnitOfMeasure
-
getValueUnitOfMeasure
The Seeq-recognized unit of measure for the values, if it exists- Returns:
- valueUnitOfMeasure
-
setValueUnitOfMeasure
-
equals
-
hashCode
public int hashCode() -
toString
-