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

Class RelatedMetadataElement

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedMetadataElement
public class RelatedMetadataElement extends org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
This property header implements any common mechanisms that all property objects need.

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    RelatedMetadataElement()
    Typical Constructor
    RelatedMetadataElement(RelatedMetadataElement 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.
    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.
    OpenMetadataElement
    getElement()
    Return the properties of the related element.
    String
    getRelationshipGUID()
    Return the unique id for the relationship .
    ElementProperties
    getRelationshipProperties()
    Return the properties associated with the relationship.
    int
    hashCode()
    Create a hash code for this element type.
    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
    setElement(OpenMetadataElement element)
    Set up the properties of the related element.
    void
    setRelationshipGUID(String guid)
    Set up the unique id for the relationship.
    void
    setRelationshipProperties(ElementProperties relationshipProperties)
    Set up the properties associated with the relationship.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RelatedMetadataElement

      public RelatedMetadataElement()
      Typical Constructor

    • RelatedMetadataElement

      public RelatedMetadataElement(RelatedMetadataElement 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

    • getRelationshipGUID

      public String getRelationshipGUID()
      Return the unique id for the relationship .
      Returns:
      String unique id

    • setRelationshipGUID

      public void setRelationshipGUID(String guid)
      Set up the unique id for the relationship.
      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

    • getRelationshipProperties

      public ElementProperties getRelationshipProperties()
      Return the properties associated with the relationship.
      Returns:
      property names and values

    • setRelationshipProperties

      public void setRelationshipProperties(ElementProperties relationshipProperties)
      Set up the properties associated with the relationship.
      Parameters:
      relationshipProperties - property names and values

    • getElement

      public OpenMetadataElement getElement()
      Return the properties of the related element.
      Returns:
      related element

    • setElement

      public void setElement(OpenMetadataElement element)
      Set up the properties of the related element.
      Parameters:
      element - related element

    • toString

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