Package io.adminshell.aas.v3.model

Interface Key

  • All Known Implementing Classes:
    DefaultKey
    public interface Key
    A key is a reference to an element by its id.

    • Method Detail

      • getIdType

        KeyType getIdType()
        Type of the key value. In case of idType = idShort local shall be true. In case type=GlobalReference idType shall not be IdShort. Constraint AASd-080: In case Key/type == GlobalReference idType shall not be any LocalKeyType (IdShort, FragmentId). Constraint AASd-081: In case Key/type==AssetAdministrationShell Key/idType shall not be any LocalKeyType (IdShort, FragmentId). More information under https://admin-shell.io/aas/3/0/RC01/Key/idType
        Returns:
        Returns the KeyType for the property idType.

      • setIdType

        void setIdType​(KeyType idType)
        Type of the key value. In case of idType = idShort local shall be true. In case type=GlobalReference idType shall not be IdShort. Constraint AASd-080: In case Key/type == GlobalReference idType shall not be any LocalKeyType (IdShort, FragmentId). Constraint AASd-081: In case Key/type==AssetAdministrationShell Key/idType shall not be any LocalKeyType (IdShort, FragmentId). More information under https://admin-shell.io/aas/3/0/RC01/Key/idType
        Parameters:
        idType - desired value for the property idType.

      • getType

        KeyElements getType()
        Denote which kind of entity is referenced. In case type = GlobalReference then the element is a global unique id. In all other cases the key references a model element of the same or of another AAS. The name of the model element is explicitly listed. More information under https://admin-shell.io/aas/3/0/RC01/Key/type
        Returns:
        Returns the KeyElements for the property type.

      • setType

        void setType​(KeyElements type)
        Denote which kind of entity is referenced. In case type = GlobalReference then the element is a global unique id. In all other cases the key references a model element of the same or of another AAS. The name of the model element is explicitly listed. More information under https://admin-shell.io/aas/3/0/RC01/Key/type
        Parameters:
        type - desired value for the property type.

      • getValue

        java.lang.String getValue()
        The key value, for example an IRDI if the idType=Irdi. More information under https://admin-shell.io/aas/3/0/RC01/Key/value
        Returns:
        Returns the String for the property value.

      • setValue

        void setValue​(java.lang.String value)
        The key value, for example an IRDI if the idType=Irdi. More information under https://admin-shell.io/aas/3/0/RC01/Key/value
        Parameters:
        value - desired value for the property value.