Package io.adminshell.aas.v3.model

Interface Referable

    • Method Detail

      • getCategory

        java.lang.String getCategory()
        The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints. More information under https://admin-shell.io/aas/3/0/RC01/Referable/category
        Returns:
        Returns the String for the property category.

      • setCategory

        void setCategory​(java.lang.String category)
        The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints. More information under https://admin-shell.io/aas/3/0/RC01/Referable/category
        Parameters:
        category - desired value for the property category.

      • getDescriptions

        java.util.List<LangString> getDescriptions()
        Description or comments on the element. The description can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/description
        Returns:
        Returns the List of LangStrings for the property descriptions.

      • setDescriptions

        void setDescriptions​(java.util.List<LangString> descriptions)
        Description or comments on the element. The description can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/description
        Parameters:
        descriptions - desired value for the property descriptions.

      • getDisplayNames

        java.util.List<LangString> getDisplayNames()
        Display name. Can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/displayName
        Returns:
        Returns the List of LangStrings for the property displayNames.

      • setDisplayNames

        void setDisplayNames​(java.util.List<LangString> displayNames)
        Display name. Can be provided in several languages. More information under https://admin-shell.io/aas/3/0/RC01/Referable/displayName
        Parameters:
        displayNames - desired value for the property displayNames.

      • getIdShort

        java.lang.String getIdShort()
        Identifying string of the element within its name space. Constraint AASd-002: idShort shall only feature letters, digits, underscore ('_'); starting with a small letter. I.e. [a-z][a-zA-Z0-9_]+. Constraint AASd-003: idShort shall be matched case-insensitive. Constraint AASd-022: idShort of non-identifiable referables shall be unqiue in its namespace. Note: In case the element is a property and the property has a semantic definition (HasSemantics) the idShort is typically identical to the short name in English. Note: In case of an identifiable element idShort is optional but recommended to be defined. It can be used for unique reference in its name space and thus allows better usability and a more performant implementation. In this case it is similar to the 'BrowserPath' in OPC UA. More information under https://admin-shell.io/aas/3/0/RC01/Referable/idShort
        Returns:
        Returns the String for the property idShort.

      • setIdShort

        void setIdShort​(java.lang.String idShort)
        Identifying string of the element within its name space. Constraint AASd-002: idShort shall only feature letters, digits, underscore ('_'); starting with a small letter. I.e. [a-z][a-zA-Z0-9_]+. Constraint AASd-003: idShort shall be matched case-insensitive. Constraint AASd-022: idShort of non-identifiable referables shall be unqiue in its namespace. Note: In case the element is a property and the property has a semantic definition (HasSemantics) the idShort is typically identical to the short name in English. Note: In case of an identifiable element idShort is optional but recommended to be defined. It can be used for unique reference in its name space and thus allows better usability and a more performant implementation. In this case it is similar to the 'BrowserPath' in OPC UA. More information under https://admin-shell.io/aas/3/0/RC01/Referable/idShort
        Parameters:
        idShort - desired value for the property idShort.