Package org.odpi.openmetadata.accessservices.governanceprogram.metadataelements

Class ElementHeader

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    ElementStub
    public class ElementHeader
extends Object
implements Serializable
    ElementHeader provides the common identifier and type information for all properties objects that link off of the asset and have a guid associated with them. This typically means it is represented by an entity in the metadata repository. In addition are useful attachments that are found connected to the metadata element.
    See Also:
    Serialized Form

    • Constructor Detail

      • ElementHeader

        public ElementHeader()
        Default constructor used by subclasses

      • ElementHeader

        public ElementHeader​(ElementHeader template)
        Copy/clone constructor.
        Parameters:
        template - element to copy

    • Method Detail

      • getGUID

        public String getGUID()
        Return the unique id for the properties object. Null means no guid is assigned.
        Returns:
        String unique id

      • setGUID

        public void setGUID​(String guid)
        Set up the guid for the element.
        Parameters:
        guid - String unique identifier

      • getStatus

        public ElementStatus getStatus()
        Return the current status of the element - typically ACTIVE.
        Returns:
        status enum

      • setStatus

        public void setStatus​(ElementStatus status)
        Set up the current status of the element - typically ACTIVE.
        Parameters:
        status - status enum

      • getType

        public ElementType getType()
        Return the element type properties for this properties object. These values are set up by the metadata repository and define details to the metadata entity used to represent this element.
        Returns:
        ElementType type information.

      • setType

        public void setType​(ElementType type)
        Set up the type of this element.
        Parameters:
        type - element type properties

      • getOrigin

        public ElementOrigin getOrigin()
        Return information about the origin of the element. This includes the metadata collection and license.
        Returns:
        element origin object

      • setOrigin

        public void setOrigin​(ElementOrigin origin)
        Set up information about the origin of the element. This includes the metadata collection and license.
        Parameters:
        origin - element origin object

      • getVersions

        public ElementVersions getVersions()
        Return detail of the element's current version and the users responsible for maintaining it.
        Returns:
        ElementVersion object

      • setVersions

        public void setVersions​(ElementVersions versions)
        Set up detail of the element's current version and the users responsible for maintaining it.
        Parameters:
        versions - ElementVersion object

      • getClassifications

        public List<ElementClassification> getClassifications()
        Return the list of classifications associated with the metadata element.
        Returns:
        Classifications list of classifications

      • setClassifications

        public void setClassifications​(List<ElementClassification> classifications)
        Set up the classifications associated with this metadata element.
        Parameters:
        classifications - list of classifications

      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class Object
        Returns:
        print out of variables in a JSON-style

      • equals

        public boolean equals​(Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class Object
        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 Object
        Returns:
        int hash code