Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class OpenMetadataElement

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataElement
public class OpenMetadataElement extends org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
OpenMetadataElement describes an entity in an open metadata repository.

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMetadataElement()
    Typical Constructor
    OpenMetadataElement(OpenMetadataElement template)
    Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    List<AttachedClassification>
    getClassifications()
    Return the list of classifications associated with the metadata element.
    Date
    getEffectiveFromTime()
    Return the date/time that this instance should start to be used (null means it can be used from creationTime).
    Date
    getEffectiveToTime()
    Return the date/time that this instance should no longer be used.
    String
    getElementGUID()
    Return the unique id for the metadata element.
    ElementProperties
    getElementProperties()
    Return the properties that are stored with the metadata element.
    int
    hashCode()
    Create a hash code for this element type.
    void
    setClassifications(List<AttachedClassification> classifications)
    Set up the list of classifications associated with the metadata element.
    void
    setEffectiveFromTime(Date effectiveFromTime)
    Set up the date/time that this instance should start to be used (null means it can be used from creationTime).
    void
    setEffectiveToTime(Date effectiveToTime)
    Set up the date/time that this instance should no longer be used.
    void
    setElementGUID(String guid)
    Set up the unique id for the metadata element.
    void
    setElementProperties(ElementProperties elementProperties)
    Set up the properties that are stored with the metadata element.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader

    getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

    getHeaderVersion, setHeaderVersion

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OpenMetadataElement

      public OpenMetadataElement()
      Typical Constructor

    • OpenMetadataElement

      public OpenMetadataElement(OpenMetadataElement template)
      Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;
      Parameters:
      template - object being copied

  • Method Details

    • getElementGUID

      public String getElementGUID()
      Return the unique id for the metadata element.
      Returns:
      String unique identifier

    • setElementGUID

      public void setElementGUID(String guid)
      Set up the unique id for the metadata element.
      Parameters:
      guid - String unique identifier

    • getEffectiveFromTime

      public Date getEffectiveFromTime()
      Return the date/time that this instance should start to be used (null means it can be used from creationTime).
      Returns:
      Date object

    • setEffectiveFromTime

      public void setEffectiveFromTime(Date effectiveFromTime)
      Set up the date/time that this instance should start to be used (null means it can be used from creationTime).
      Parameters:
      effectiveFromTime - Date object

    • getEffectiveToTime

      public Date getEffectiveToTime()
      Return the date/time that this instance should no longer be used.
      Returns:
      Date object

    • setEffectiveToTime

      public void setEffectiveToTime(Date effectiveToTime)
      Set up the date/time that this instance should no longer be used.
      Parameters:
      effectiveToTime - Date object

    • getClassifications

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

    • setClassifications

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

    • getElementProperties

      public ElementProperties getElementProperties()
      Return the properties that are stored with the metadata element. The ElementType includes the list of valid property names.
      Returns:
      property map

    • setElementProperties

      public void setElementProperties(ElementProperties elementProperties)
      Set up the properties that are stored with the metadata element. The ElementType includes the list of valid property names.
      Parameters:
      elementProperties - property map

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
      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 org.odpi.openmetadata.frameworks.connectors.properties.beans.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 org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
      Returns:
      int hash code