Class ClassAttributeAssignmentModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class ClassAttributeAssignmentModel
    extends ItemModel
    Generated model class for type ClassAttributeAssignment first defined at extension catalog.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ATTRIBUTETYPE
      Generated constant - Attribute key of ClassAttributeAssignment.attributeType attribute defined at extension catalog.
      static java.lang.String ATTRIBUTEVALUEDISPLAYSTRING
      Generated constant - Attribute key of ClassAttributeAssignment.attributeValueDisplayString attribute defined at extension catalog.
      static java.lang.String ATTRIBUTEVALUES
      Generated constant - Attribute key of ClassAttributeAssignment.attributeValues attribute defined at extension catalog.
      static java.lang.String CLASSIFICATIONATTRIBUTE
      Generated constant - Attribute key of ClassAttributeAssignment.classificationAttribute attribute defined at extension catalog.
      static java.lang.String CLASSIFICATIONCLASS
      Generated constant - Attribute key of ClassAttributeAssignment.classificationClass attribute defined at extension catalog.
      static java.lang.String COMPARABLE
      Generated constant - Attribute key of ClassAttributeAssignment.comparable attribute defined at extension catalog.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of ClassAttributeAssignment.description attribute defined at extension catalog.
      static java.lang.String ENABLEWYSIWYGEDITOR
      Generated constant - Attribute key of ClassAttributeAssignment.enableWysiwygEditor attribute defined at extension platformbackoffice.
      static java.lang.String EXTERNALID
      Generated constant - Attribute key of ClassAttributeAssignment.externalID attribute defined at extension catalog.
      static java.lang.String FORMATDEFINITION
      Generated constant - Attribute key of ClassAttributeAssignment.formatDefinition attribute defined at extension catalog.
      static java.lang.String LISTABLE
      Generated constant - Attribute key of ClassAttributeAssignment.listable attribute defined at extension catalog.
      static java.lang.String LOCALIZED
      Generated constant - Attribute key of ClassAttributeAssignment.localized attribute defined at extension catalog.
      static java.lang.String MANDATORY
      Generated constant - Attribute key of ClassAttributeAssignment.mandatory attribute defined at extension catalog.
      static java.lang.String MULTIVALUED
      Generated constant - Attribute key of ClassAttributeAssignment.multiValued attribute defined at extension catalog.
      static java.lang.String POSITION
      Generated constant - Attribute key of ClassAttributeAssignment.position attribute defined at extension catalog.
      static java.lang.String RANGE
      Generated constant - Attribute key of ClassAttributeAssignment.range attribute defined at extension catalog.
      static java.lang.String REFERENCEINCLUDESSUBTYPES
      Generated constant - Attribute key of ClassAttributeAssignment.referenceIncludesSubTypes attribute defined at extension catalog.
      static java.lang.String REFERENCETYPE
      Generated constant - Attribute key of ClassAttributeAssignment.referenceType attribute defined at extension catalog.
      static java.lang.String SEARCHABLE
      Generated constant - Attribute key of ClassAttributeAssignment.searchable attribute defined at extension catalog.
      static java.lang.String SYSTEMVERSION
      Generated constant - Attribute key of ClassAttributeAssignment.systemVersion attribute defined at extension catalog.
      static java.lang.String UNIT
      Generated constant - Attribute key of ClassAttributeAssignment.unit attribute defined at extension catalog.
      static java.lang.String VISIBILITY
      Generated constant - Attribute key of ClassAttributeAssignment.visibility attribute defined at extension catalog.
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • CLASSIFICATIONCLASS

        public static final java.lang.String CLASSIFICATIONCLASS
        Generated constant - Attribute key of ClassAttributeAssignment.classificationClass attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • CLASSIFICATIONATTRIBUTE

        public static final java.lang.String CLASSIFICATIONATTRIBUTE
        Generated constant - Attribute key of ClassAttributeAssignment.classificationAttribute attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of ClassAttributeAssignment.description attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • SYSTEMVERSION

        public static final java.lang.String SYSTEMVERSION
        Generated constant - Attribute key of ClassAttributeAssignment.systemVersion attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • POSITION

        public static final java.lang.String POSITION
        Generated constant - Attribute key of ClassAttributeAssignment.position attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • EXTERNALID

        public static final java.lang.String EXTERNALID
        Generated constant - Attribute key of ClassAttributeAssignment.externalID attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • UNIT

        public static final java.lang.String UNIT
        Generated constant - Attribute key of ClassAttributeAssignment.unit attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • MANDATORY

        public static final java.lang.String MANDATORY
        Generated constant - Attribute key of ClassAttributeAssignment.mandatory attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • LOCALIZED

        public static final java.lang.String LOCALIZED
        Generated constant - Attribute key of ClassAttributeAssignment.localized attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • RANGE

        public static final java.lang.String RANGE
        Generated constant - Attribute key of ClassAttributeAssignment.range attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • MULTIVALUED

        public static final java.lang.String MULTIVALUED
        Generated constant - Attribute key of ClassAttributeAssignment.multiValued attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • SEARCHABLE

        public static final java.lang.String SEARCHABLE
        Generated constant - Attribute key of ClassAttributeAssignment.searchable attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • ATTRIBUTETYPE

        public static final java.lang.String ATTRIBUTETYPE
        Generated constant - Attribute key of ClassAttributeAssignment.attributeType attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • REFERENCETYPE

        public static final java.lang.String REFERENCETYPE
        Generated constant - Attribute key of ClassAttributeAssignment.referenceType attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • REFERENCEINCLUDESSUBTYPES

        public static final java.lang.String REFERENCEINCLUDESSUBTYPES
        Generated constant - Attribute key of ClassAttributeAssignment.referenceIncludesSubTypes attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • FORMATDEFINITION

        public static final java.lang.String FORMATDEFINITION
        Generated constant - Attribute key of ClassAttributeAssignment.formatDefinition attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • LISTABLE

        public static final java.lang.String LISTABLE
        Generated constant - Attribute key of ClassAttributeAssignment.listable attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • COMPARABLE

        public static final java.lang.String COMPARABLE
        Generated constant - Attribute key of ClassAttributeAssignment.comparable attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • VISIBILITY

        public static final java.lang.String VISIBILITY
        Generated constant - Attribute key of ClassAttributeAssignment.visibility attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • ATTRIBUTEVALUES

        public static final java.lang.String ATTRIBUTEVALUES
        Generated constant - Attribute key of ClassAttributeAssignment.attributeValues attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • ATTRIBUTEVALUEDISPLAYSTRING

        public static final java.lang.String ATTRIBUTEVALUEDISPLAYSTRING
        Generated constant - Attribute key of ClassAttributeAssignment.attributeValueDisplayString attribute defined at extension catalog.
        See Also:
        Constant Field Values
      • ENABLEWYSIWYGEDITOR

        public static final java.lang.String ENABLEWYSIWYGEDITOR
        Generated constant - Attribute key of ClassAttributeAssignment.enableWysiwygEditor attribute defined at extension platformbackoffice.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ClassAttributeAssignmentModel

        public ClassAttributeAssignmentModel()
        Generated constructor - Default constructor for generic creation.
      • ClassAttributeAssignmentModel

        public ClassAttributeAssignmentModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • ClassAttributeAssignmentModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public ClassAttributeAssignmentModel​(ClassificationAttributeModel _classificationAttribute,
                                             ClassificationClassModel _classificationClass)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _classificationAttribute - initial attribute declared by type ClassAttributeAssignment at extension catalog
        _classificationClass - initial attribute declared by type ClassAttributeAssignment at extension catalog
      • ClassAttributeAssignmentModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public ClassAttributeAssignmentModel​(ClassificationAttributeModel _classificationAttribute,
                                             ClassificationClassModel _classificationClass,
                                             ItemModel _owner,
                                             ClassificationSystemVersionModel _systemVersion)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _classificationAttribute - initial attribute declared by type ClassAttributeAssignment at extension catalog
        _classificationClass - initial attribute declared by type ClassAttributeAssignment at extension catalog
        _owner - initial attribute declared by type Item at extension core
        _systemVersion - initial attribute declared by type ClassAttributeAssignment at extension catalog
    • Method Detail

      • getAttributeType

        @Accessor(qualifier="attributeType",
                  type=GETTER)
        public ClassificationAttributeTypeEnum getAttributeType()
        Generated method - Getter of the ClassAttributeAssignment.attributeType attribute defined at extension catalog.
        Returns:
        the attributeType - Type of attribute: string, number, boolean or range
      • getAttributeValueDisplayString

        @Accessor(qualifier="attributeValueDisplayString",
                  type=GETTER)
        public java.lang.String getAttributeValueDisplayString()
        Generated method - Getter of the ClassAttributeAssignment.attributeValueDisplayString attribute defined at extension catalog.
        Returns:
        the attributeValueDisplayString
      • getAttributeValueDisplayString

        @Accessor(qualifier="attributeValueDisplayString",
                  type=GETTER)
        public java.lang.String getAttributeValueDisplayString​(java.util.Locale loc)
        Generated method - Getter of the ClassAttributeAssignment.attributeValueDisplayString attribute defined at extension catalog.
        Parameters:
        loc - the value localization key
        Returns:
        the attributeValueDisplayString
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getAttributeValues

        @Accessor(qualifier="attributeValues",
                  type=GETTER)
        public java.util.List<ClassificationAttributeValueModel> getAttributeValues()
        Generated method - Getter of the ClassAttributeAssignment.attributeValues attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the attributeValues
      • getClassificationAttribute

        @Accessor(qualifier="classificationAttribute",
                  type=GETTER)
        public ClassificationAttributeModel getClassificationAttribute()
        Generated method - Getter of the ClassAttributeAssignment.classificationAttribute attribute defined at extension catalog.
        Returns:
        the classificationAttribute
      • getClassificationClass

        @Accessor(qualifier="classificationClass",
                  type=GETTER)
        public ClassificationClassModel getClassificationClass()
        Generated method - Getter of the ClassAttributeAssignment.classificationClass attribute defined at extension catalog.
        Returns:
        the classificationClass
      • getComparable

        @Accessor(qualifier="comparable",
                  type=GETTER)
        public java.lang.Boolean getComparable()
        Generated method - Getter of the ClassAttributeAssignment.comparable attribute defined at extension catalog.
        Returns:
        the comparable
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription()
        Generated method - Getter of the ClassAttributeAssignment.description attribute defined at extension catalog.
        Returns:
        the description - description of attribute usage
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription​(java.util.Locale loc)
        Generated method - Getter of the ClassAttributeAssignment.description attribute defined at extension catalog.
        Parameters:
        loc - the value localization key
        Returns:
        the description - description of attribute usage
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getEnableWysiwygEditor

        @Accessor(qualifier="enableWysiwygEditor",
                  type=GETTER)
        public java.lang.Boolean getEnableWysiwygEditor()
        Generated method - Getter of the ClassAttributeAssignment.enableWysiwygEditor attribute defined at extension platformbackoffice.
        Returns:
        the enableWysiwygEditor
      • getExternalID

        @Accessor(qualifier="externalID",
                  type=GETTER)
        public java.lang.String getExternalID()
        Generated method - Getter of the ClassAttributeAssignment.externalID attribute defined at extension catalog.
        Returns:
        the externalID - external identifier refering to the actual classification system definition
      • getFormatDefinition

        @Accessor(qualifier="formatDefinition",
                  type=GETTER)
        public java.lang.String getFormatDefinition()
        Generated method - Getter of the ClassAttributeAssignment.formatDefinition attribute defined at extension catalog.
        Returns:
        the formatDefinition - Format definition string: optionally used e.g. as number format
      • getListable

        @Accessor(qualifier="listable",
                  type=GETTER)
        public java.lang.Boolean getListable()
        Generated method - Getter of the ClassAttributeAssignment.listable attribute defined at extension catalog.
        Returns:
        the listable
      • getLocalized

        @Accessor(qualifier="localized",
                  type=GETTER)
        public java.lang.Boolean getLocalized()
        Generated method - Getter of the ClassAttributeAssignment.localized attribute defined at extension catalog.
        Returns:
        the localized
      • getMandatory

        @Accessor(qualifier="mandatory",
                  type=GETTER)
        public java.lang.Boolean getMandatory()
        Generated method - Getter of the ClassAttributeAssignment.mandatory attribute defined at extension catalog.
        Returns:
        the mandatory
      • getMultiValued

        @Accessor(qualifier="multiValued",
                  type=GETTER)
        public java.lang.Boolean getMultiValued()
        Generated method - Getter of the ClassAttributeAssignment.multiValued attribute defined at extension catalog.
        Returns:
        the multiValued
      • getPosition

        @Accessor(qualifier="position",
                  type=GETTER)
        public java.lang.Integer getPosition()
        Generated method - Getter of the ClassAttributeAssignment.position attribute defined at extension catalog.
        Returns:
        the position
      • getRange

        @Accessor(qualifier="range",
                  type=GETTER)
        public java.lang.Boolean getRange()
        Generated method - Getter of the ClassAttributeAssignment.range attribute defined at extension catalog.
        Returns:
        the range
      • getReferenceIncludesSubTypes

        @Accessor(qualifier="referenceIncludesSubTypes",
                  type=GETTER)
        public java.lang.Boolean getReferenceIncludesSubTypes()
        Generated method - Getter of the ClassAttributeAssignment.referenceIncludesSubTypes attribute defined at extension catalog.
        Returns:
        the referenceIncludesSubTypes
      • getReferenceType

        @Accessor(qualifier="referenceType",
                  type=GETTER)
        public ComposedTypeModel getReferenceType()
        Generated method - Getter of the ClassAttributeAssignment.referenceType attribute defined at extension catalog.
        Returns:
        the referenceType
      • getSearchable

        @Accessor(qualifier="searchable",
                  type=GETTER)
        public java.lang.Boolean getSearchable()
        Generated method - Getter of the ClassAttributeAssignment.searchable attribute defined at extension catalog.
        Returns:
        the searchable
      • getVisibility

        @Accessor(qualifier="visibility",
                  type=GETTER)
        public ClassificationAttributeVisibilityEnum getVisibility()
        Generated method - Getter of the ClassAttributeAssignment.visibility attribute defined at extension catalog.
        Returns:
        the visibility - Visibility of attribute: visible, not_visible, visible_in_base or visible_in_variant
      • setAttributeType

        @Accessor(qualifier="attributeType",
                  type=SETTER)
        public void setAttributeType​(ClassificationAttributeTypeEnum value)
        Generated method - Setter of ClassAttributeAssignment.attributeType attribute defined at extension catalog.
        Parameters:
        value - the attributeType - Type of attribute: string, number, boolean or range
      • setAttributeValues

        @Accessor(qualifier="attributeValues",
                  type=SETTER)
        public void setAttributeValues​(java.util.List<ClassificationAttributeValueModel> value)
        Generated method - Setter of ClassAttributeAssignment.attributeValues attribute defined at extension catalog.
        Parameters:
        value - the attributeValues
      • setClassificationAttribute

        @Accessor(qualifier="classificationAttribute",
                  type=SETTER)
        public void setClassificationAttribute​(ClassificationAttributeModel value)
        Generated method - Initial setter of ClassAttributeAssignment.classificationAttribute attribute defined at extension catalog. Can only be used at creation of model - before first save.
        Parameters:
        value - the classificationAttribute
      • setClassificationClass

        @Accessor(qualifier="classificationClass",
                  type=SETTER)
        public void setClassificationClass​(ClassificationClassModel value)
        Generated method - Setter of ClassAttributeAssignment.classificationClass attribute defined at extension catalog.
        Parameters:
        value - the classificationClass
      • setComparable

        @Accessor(qualifier="comparable",
                  type=SETTER)
        public void setComparable​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.comparable attribute defined at extension catalog.
        Parameters:
        value - the comparable
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value)
        Generated method - Setter of ClassAttributeAssignment.description attribute defined at extension catalog.
        Parameters:
        value - the description - description of attribute usage
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value,
                                   java.util.Locale loc)
        Generated method - Setter of ClassAttributeAssignment.description attribute defined at extension catalog.
        Parameters:
        value - the description - description of attribute usage
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setEnableWysiwygEditor

        @Accessor(qualifier="enableWysiwygEditor",
                  type=SETTER)
        public void setEnableWysiwygEditor​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.enableWysiwygEditor attribute defined at extension platformbackoffice.
        Parameters:
        value - the enableWysiwygEditor
      • setExternalID

        @Accessor(qualifier="externalID",
                  type=SETTER)
        public void setExternalID​(java.lang.String value)
        Generated method - Setter of ClassAttributeAssignment.externalID attribute defined at extension catalog.
        Parameters:
        value - the externalID - external identifier refering to the actual classification system definition
      • setFormatDefinition

        @Accessor(qualifier="formatDefinition",
                  type=SETTER)
        public void setFormatDefinition​(java.lang.String value)
        Generated method - Setter of ClassAttributeAssignment.formatDefinition attribute defined at extension catalog.
        Parameters:
        value - the formatDefinition - Format definition string: optionally used e.g. as number format
      • setListable

        @Accessor(qualifier="listable",
                  type=SETTER)
        public void setListable​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.listable attribute defined at extension catalog.
        Parameters:
        value - the listable
      • setLocalized

        @Accessor(qualifier="localized",
                  type=SETTER)
        public void setLocalized​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.localized attribute defined at extension catalog.
        Parameters:
        value - the localized
      • setMandatory

        @Accessor(qualifier="mandatory",
                  type=SETTER)
        public void setMandatory​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.mandatory attribute defined at extension catalog.
        Parameters:
        value - the mandatory
      • setMultiValued

        @Accessor(qualifier="multiValued",
                  type=SETTER)
        public void setMultiValued​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.multiValued attribute defined at extension catalog.
        Parameters:
        value - the multiValued
      • setPosition

        @Accessor(qualifier="position",
                  type=SETTER)
        public void setPosition​(java.lang.Integer value)
        Generated method - Setter of ClassAttributeAssignment.position attribute defined at extension catalog.
        Parameters:
        value - the position
      • setRange

        @Accessor(qualifier="range",
                  type=SETTER)
        public void setRange​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.range attribute defined at extension catalog.
        Parameters:
        value - the range
      • setReferenceIncludesSubTypes

        @Accessor(qualifier="referenceIncludesSubTypes",
                  type=SETTER)
        public void setReferenceIncludesSubTypes​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.referenceIncludesSubTypes attribute defined at extension catalog.
        Parameters:
        value - the referenceIncludesSubTypes
      • setReferenceType

        @Accessor(qualifier="referenceType",
                  type=SETTER)
        public void setReferenceType​(ComposedTypeModel value)
        Generated method - Setter of ClassAttributeAssignment.referenceType attribute defined at extension catalog.
        Parameters:
        value - the referenceType
      • setSearchable

        @Accessor(qualifier="searchable",
                  type=SETTER)
        public void setSearchable​(java.lang.Boolean value)
        Generated method - Setter of ClassAttributeAssignment.searchable attribute defined at extension catalog.
        Parameters:
        value - the searchable
      • setSystemVersion

        @Accessor(qualifier="systemVersion",
                  type=SETTER)
        public void setSystemVersion​(ClassificationSystemVersionModel value)
        Generated method - Initial setter of ClassAttributeAssignment.systemVersion attribute defined at extension catalog. Can only be used at creation of model - before first save.
        Parameters:
        value - the systemVersion
      • setVisibility

        @Accessor(qualifier="visibility",
                  type=SETTER)
        public void setVisibility​(ClassificationAttributeVisibilityEnum value)
        Generated method - Setter of ClassAttributeAssignment.visibility attribute defined at extension catalog.
        Parameters:
        value - the visibility - Visibility of attribute: visible, not_visible, visible_in_base or visible_in_variant