Package io.adminshell.aas.v3.model
Interface Entity
-
- All Superinterfaces:
HasDataSpecification,HasExtensions,HasKind,HasSemantics,Qualifiable,Referable,SubmodelElement
- All Known Implementing Classes:
DefaultEntity
public interface Entity extends SubmodelElement
An entity is a submodel element that is used to model entities. Constraint AASd-056: The semanticId of a Entity submodel element shall only reference a ConceptDescription with the category ENTITY. The ConceptDescription describes the elements assigned to the entity via Entity/statement.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EntityTypegetEntityType()Describes whether the entity is a co-managed entity or a self-managed entity.ReferencegetGlobalAssetId()Reference to the asset the entity is representing.IdentifierKeyValuePairgetSpecificAssetId()Reference to an identifier key value pair representing an external identifier of the asset represented by the asset administration shell.java.util.List<SubmodelElement>getStatements()Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value.voidsetEntityType(EntityType entityType)Describes whether the entity is a co-managed entity or a self-managed entity.voidsetGlobalAssetId(Reference globalAssetId)Reference to the asset the entity is representing.voidsetSpecificAssetId(IdentifierKeyValuePair specificAssetId)Reference to an identifier key value pair representing an external identifier of the asset represented by the asset administration shell.voidsetStatements(java.util.List<SubmodelElement> statements)Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value.-
Methods inherited from interface io.adminshell.aas.v3.model.HasDataSpecification
getEmbeddedDataSpecifications, setEmbeddedDataSpecifications
-
Methods inherited from interface io.adminshell.aas.v3.model.HasExtensions
getExtensions, setExtensions
-
Methods inherited from interface io.adminshell.aas.v3.model.HasSemantics
getSemanticId, setSemanticId
-
Methods inherited from interface io.adminshell.aas.v3.model.Qualifiable
getQualifiers, setQualifiers
-
Methods inherited from interface io.adminshell.aas.v3.model.Referable
getCategory, getDescriptions, getDisplayNames, getIdShort, setCategory, setDescriptions, setDisplayNames, setIdShort
-
-
-
-
Method Detail
-
getGlobalAssetId
Reference getGlobalAssetId()
Reference to the asset the entity is representing. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/globalAssetId- Returns:
- Returns the Reference for the property globalAssetId.
-
setGlobalAssetId
void setGlobalAssetId(Reference globalAssetId)
Reference to the asset the entity is representing. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/globalAssetId- Parameters:
globalAssetId- desired value for the property globalAssetId.
-
getSpecificAssetId
IdentifierKeyValuePair getSpecificAssetId()
Reference to an identifier key value pair representing an external identifier of the asset represented by the asset administration shell. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/specificAssetId- Returns:
- Returns the IdentifierKeyValuePair for the property specificAssetId.
-
setSpecificAssetId
void setSpecificAssetId(IdentifierKeyValuePair specificAssetId)
Reference to an identifier key value pair representing an external identifier of the asset represented by the asset administration shell. The asset attribute must be set if entityType is set to 'SelfManagedEntity'. It is empty otherwise. Constraint AASd-014: Either the attribute globalAssetId or externalAssetId of an Entity must be set if Entity/entityType is set to 'SelfManagedEntity'. They are not existing otherwise. More information under https://admin-shell.io/aas/3/0/RC01/Entity/specificAssetId- Parameters:
specificAssetId- desired value for the property specificAssetId.
-
getEntityType
EntityType getEntityType()
Describes whether the entity is a co-managed entity or a self-managed entity. More information under https://admin-shell.io/aas/3/0/RC01/Entity/entityType- Returns:
- Returns the EntityType for the property entityType.
-
setEntityType
void setEntityType(EntityType entityType)
Describes whether the entity is a co-managed entity or a self-managed entity. More information under https://admin-shell.io/aas/3/0/RC01/Entity/entityType- Parameters:
entityType- desired value for the property entityType.
-
getStatements
java.util.List<SubmodelElement> getStatements()
Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value. More information under https://admin-shell.io/aas/3/0/RC01/Entity/statement- Returns:
- Returns the List of SubmodelElements for the property statements.
-
setStatements
void setStatements(java.util.List<SubmodelElement> statements)
Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value. More information under https://admin-shell.io/aas/3/0/RC01/Entity/statement- Parameters:
statements- desired value for the property statements.
-
-