Package io.adminshell.aas.v3.model

Interface DataSpecificationIEC61360

  • All Superinterfaces:
    DataSpecificationContent
    All Known Implementing Classes:
    DefaultDataSpecificationIEC61360
    public interface DataSpecificationIEC61360
extends DataSpecificationContent
    Data Specification Template for defining Property Descriptions conformant to IEC 61360. Constraint AASd-075: For all ConceptDescriptions using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) values for the attributes not being marked as mandatory or optional in tables Table 9, Table 10, Table 11 and Table 12.depending on its category are ignored and handled as undefined.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      DataTypeIEC61360 getDataType()
      Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined.
      java.util.List<LangString> getDefinitions()
      Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English.
      java.util.List<LevelType> getLevelTypes()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
      java.util.List<LangString> getPreferredNames()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
      java.util.List<LangString> getShortNames()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
      java.lang.String getSourceOfDefinition()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
      java.lang.String getSymbol()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
      java.lang.String getUnit()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
      Reference getUnitId()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
      java.lang.String getValue()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
      java.lang.String getValueFormat()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
      Reference getValueId()
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
      ValueList getValueList()
      The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration.
      void setDataType​(DataTypeIEC61360 dataType)
      Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined.
      void setDefinitions​(java.util.List<LangString> definitions)
      Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English.
      void setLevelTypes​(java.util.List<LevelType> levelTypes)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
      void setPreferredNames​(java.util.List<LangString> preferredNames)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
      void setShortNames​(java.util.List<LangString> shortNames)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
      void setSourceOfDefinition​(java.lang.String sourceOfDefinition)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
      void setSymbol​(java.lang.String symbol)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
      void setUnit​(java.lang.String unit)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
      void setUnitId​(Reference unitId)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
      void setValue​(java.lang.String value)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
      void setValueFormat​(java.lang.String valueFormat)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
      void setValueId​(Reference valueId)
      More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
      void setValueList​(ValueList valueList)
      The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration.

    • Method Detail

      • getDataType

        DataTypeIEC61360 getDataType()
        Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. Constraint AASd-071: For a ConceptDescription with category REFERENCE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is STRING by default. Constraint AASd-072: For a ConceptDescription with category DOCUMENT using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType shall be one of the following values: STRING or URL. Constraint AASd-073: For a ConceptDescription with category QUALIFIER using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/dataType
        Returns:
        Returns the DataTypeIEC61360 for the property dataType.

      • setDataType

        void setDataType​(DataTypeIEC61360 dataType)
        Constraint AASd-070: For a ConceptDescription with category PROPERTY or VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. Constraint AASd-071: For a ConceptDescription with category REFERENCE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is STRING by default. Constraint AASd-072: For a ConceptDescription with category DOCUMENT using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType shall be one of the following values: STRING or URL. Constraint AASd-073: For a ConceptDescription with category QUALIFIER using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/dataType is mandatory and shall be defined. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/dataType
        Parameters:
        dataType - desired value for the property dataType.

      • getDefinitions

        java.util.List<LangString> getDefinitions()
        Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/definition
        Returns:
        Returns the List of LangStrings for the property definitions.

      • setDefinitions

        void setDefinitions​(java.util.List<LangString> definitions)
        Constraint AASd-074: For all ConceptDescriptions except for ConceptDescriptions of category VALUE using data specification template IEC61360 (http://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/2/0) - DataSpecificationIEC61360/definition is mandatory and shall be defined at least in English. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/definition
        Parameters:
        definitions - desired value for the property definitions.

      • getLevelTypes

        java.util.List<LevelType> getLevelTypes()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
        Returns:
        Returns the List of LevelTypes for the property levelTypes.

      • setLevelTypes

        void setLevelTypes​(java.util.List<LevelType> levelTypes)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/levelType
        Parameters:
        levelTypes - desired value for the property levelTypes.

      • getPreferredNames

        java.util.List<LangString> getPreferredNames()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
        Returns:
        Returns the List of LangStrings for the property preferredNames.

      • setPreferredNames

        void setPreferredNames​(java.util.List<LangString> preferredNames)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/preferredName
        Parameters:
        preferredNames - desired value for the property preferredNames.

      • getShortNames

        java.util.List<LangString> getShortNames()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
        Returns:
        Returns the List of LangStrings for the property shortNames.

      • setShortNames

        void setShortNames​(java.util.List<LangString> shortNames)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/shortName
        Parameters:
        shortNames - desired value for the property shortNames.

      • getSourceOfDefinition

        java.lang.String getSourceOfDefinition()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
        Returns:
        Returns the String for the property sourceOfDefinition.

      • setSourceOfDefinition

        void setSourceOfDefinition​(java.lang.String sourceOfDefinition)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/sourceOfDefinition
        Parameters:
        sourceOfDefinition - desired value for the property sourceOfDefinition.

      • getSymbol

        java.lang.String getSymbol()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
        Returns:
        Returns the String for the property symbol.

      • setSymbol

        void setSymbol​(java.lang.String symbol)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/symbol
        Parameters:
        symbol - desired value for the property symbol.

      • getUnit

        java.lang.String getUnit()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
        Returns:
        Returns the String for the property unit.

      • setUnit

        void setUnit​(java.lang.String unit)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unit
        Parameters:
        unit - desired value for the property unit.

      • getUnitId

        Reference getUnitId()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
        Returns:
        Returns the Reference for the property unitId.

      • setUnitId

        void setUnitId​(Reference unitId)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/unitId
        Parameters:
        unitId - desired value for the property unitId.

      • getValueFormat

        java.lang.String getValueFormat()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
        Returns:
        Returns the String for the property valueFormat.

      • setValueFormat

        void setValueFormat​(java.lang.String valueFormat)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueFormat
        Parameters:
        valueFormat - desired value for the property valueFormat.

      • getValue

        java.lang.String getValue()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
        Returns:
        Returns the String for the property value.

      • setValue

        void setValue​(java.lang.String value)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/value
        Parameters:
        value - desired value for the property value.

      • getValueList

        ValueList getValueList()
        The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration. The value list is a set of value reference pairs. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueList
        Returns:
        Returns the ValueList for the property valueList.

      • setValueList

        void setValueList​(ValueList valueList)
        The Type 'ValueList' lists all the allowed values for a concept description for which the allowed values are listed in an enumeration. The value list is a set of value reference pairs. More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueList
        Parameters:
        valueList - desired value for the property valueList.

      • getValueId

        Reference getValueId()
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
        Returns:
        Returns the Reference for the property valueId.

      • setValueId

        void setValueId​(Reference valueId)
        More information under https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0/RC01/DataSpecificationIEC61360/valueId
        Parameters:
        valueId - desired value for the property valueId.