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

Class OpenMetadataRelationship

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataRelationship
public class OpenMetadataRelationship extends ElementControlHeader
Structure for returning a relationship between two metadata elements.

  • Constructor Details

    • OpenMetadataRelationship

      public OpenMetadataRelationship()
      Typical Constructor

    • OpenMetadataRelationship

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

    • getRelationshipType

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

    • setRelationshipType

      public void setRelationshipType(ElementType relationshipType)
      Set up the element type properties for this relationship object. These values are set up by the metadata repository and define details to the metadata relationship used to represent this element.
      Parameters:
      relationshipType - element type properties

    • 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

    • getElementGUIDAtEnd1

      public String getElementGUIDAtEnd1()
      Return the unique identifier of the element at end 1 of the relationship.
      Returns:
      related element

    • setElementGUIDAtEnd1

      public void setElementGUIDAtEnd1(String elementGUIDAtEnd1)
      Set up the unique identifier of the element at end 1 of the relationship.
      Parameters:
      elementGUIDAtEnd1 - related element

    • getElementGUIDAtEnd2

      public String getElementGUIDAtEnd2()
      Return the unique identifier of the element at end 2 of the relationship.
      Returns:
      related element

    • setElementGUIDAtEnd2

      public void setElementGUIDAtEnd2(String elementGUIDAtEnd2)
      Set up the unique identifier of the element at end 2 of the relationship.
      Parameters:
      elementGUIDAtEnd2 - related element

    • getLabelAtEnd1

      public String getLabelAtEnd1()
      Return the descriptive label for end 1 of the relationship.
      Returns:
      string name

    • setLabelAtEnd1

      public void setLabelAtEnd1(String labelAtEnd1)
      Set up the descriptive label for end 1 of the relationship.
      Parameters:
      labelAtEnd1 - string name

    • getLabelAtEnd2

      public String getLabelAtEnd2()
      Return the descriptive label for end 2 of the relationship.
      Returns:
      string name

    • setLabelAtEnd2

      public void setLabelAtEnd2(String labelAtEnd2)
      Set up the descriptive label for end 2 of the relationship.
      Parameters:
      labelAtEnd2 - string name

    • getElementAtEnd1

      public ElementStub getElementAtEnd1()
      Return details of the element at end 1 of this relationship.
      Returns:
      element stub

    • setElementAtEnd1

      public void setElementAtEnd1(ElementStub elementAtEnd1)
      Set up details of the element at end 1 of this relationship.
      Parameters:
      elementAtEnd1 - element stub

    • getElementAtEnd2

      public ElementStub getElementAtEnd2()
      Return details of the element at end 2 of this relationship.
      Returns:
      element stub

    • setElementAtEnd2

      public void setElementAtEnd2(ElementStub elementAtEnd2)
      Set up details of the element at end 2 of this relationship.
      Parameters:
      elementAtEnd2 - element stub

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class 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 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