Package org.odpi.openmetadata.frameworks.openmetadata.metadataelements

Class ElementControlHeader

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
Direct Known Subclasses:
ElementClassificationHeader, ElementHeader, OpenMetadataElement, OpenMetadataRelationship, RelatedMetadataElement
public class ElementControlHeader extends Object
The ElementControlHeader bean provides details of the origin and changes associated with the element.

  • Field Details

    • CURRENT_AUDIT_HEADER_VERSION

      public static final long CURRENT_AUDIT_HEADER_VERSION
      Version identifier
      See Also:

  • Constructor Details

    • ElementControlHeader

      public ElementControlHeader()
      Default constructor used by subclasses

    • ElementControlHeader

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

  • Method Details

    • getHeaderVersion

      public long getHeaderVersion()
      Return the version of this header. This is used by the OMRS to determine if it is back level and should not process events from a source that is more advanced because it does not have the ability to receive all the header properties.
      Returns:
      long version number - the value is incremented each time a new non-informational field is added to the audit header.

    • setHeaderVersion

      public void setHeaderVersion(long headerVersion)
      Return the version of this header. This is used by the OMRS to determine if it is back level and should not process events from a source that is more advanced because it does not have the ability to receive all the header properties.
      Parameters:
      headerVersion - long version number - the value is incremented each time a new non-informational field is added to the audit header.

    • 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

    • 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