Class ElementClassificationHeader

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    ElementClassification, SecurityTags

    public class ElementClassificationHeader
    extends ElementControlHeader
    The ElementClassificationHeader bean describes the header for a classification associated with an element. The ElementClassification is a generic classification. Then classes such as SecurityTags are specifically featured classifications.
    See Also:
    Serialized Form
    • Constructor Detail

      • ElementClassificationHeader

        public ElementClassificationHeader()
        Default constructor
      • ElementClassificationHeader

        public ElementClassificationHeader​(ElementClassificationHeader template)
        Copy/clone constructor
        Parameters:
        template - template to copy
    • Method Detail

      • setClassificationTypeId

        public void setClassificationTypeId​(String classificationTypeId)
        Set up the unique identifier for the element's type.
        Parameters:
        classificationTypeId - String identifier
      • getClassificationTypeId

        public String getClassificationTypeId()
        Return unique identifier for the element's type.
        Returns:
        element type id
      • setClassificationTypeVersion

        public void setClassificationTypeVersion​(long classificationTypeVersion)
        Set up the version number for this element's type
        Parameters:
        classificationTypeVersion - version number for the element type.
      • getClassificationTypeVersion

        public long getClassificationTypeVersion()
        Return the version number for this element's type.
        Returns:
        elementTypeVersion version number for the element type.
      • setClassificationTypeDescription

        public void setClassificationTypeDescription​(String classificationTypeDescription)
        Set up a short description of this element's type.
        Parameters:
        classificationTypeDescription - set up the description for this element's type
      • getClassificationTypeDescription

        public String getClassificationTypeDescription()
        Return the description for this element's type.
        Returns:
        elementTypeDescription String description for the element type
      • getClassificationOrigin

        public ClassificationOrigin getClassificationOrigin()
        Return whether the classification was added explicitly to this asset or propagated from another entity.
        Returns:
        classification origin enum
      • setClassificationOrigin

        public void setClassificationOrigin​(ClassificationOrigin classificationOrigin)
        Set up the setting for classification origin
        Parameters:
        classificationOrigin - enum
      • getClassificationOriginGUID

        public String getClassificationOriginGUID()
        Return the entity guid that the classification was propagated from (or null if not propagated).
        Returns:
        string guid
      • setClassificationOriginGUID

        public void setClassificationOriginGUID​(String classificationOriginGUID)
        Set up the origin of the classification.
        Parameters:
        classificationOriginGUID - string guid
      • equals

        public boolean equals​(Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class ElementControlHeader
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class ElementControlHeader
        Returns:
        int hash code