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

Class RelatedMetadataElementSummary

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedMetadataElementSummary
Direct Known Subclasses:
CertificationElement, ChildCategoryElement
public class RelatedMetadataElementSummary extends Object
RelatedBy contains the properties and header for a relationship retrieved from the metadata repository along with the stub of the related element.

  • Constructor Details

    • RelatedMetadataElementSummary

      public RelatedMetadataElementSummary()
      Default constructor

    • RelatedMetadataElementSummary

      public RelatedMetadataElementSummary(RelatedMetadataElementSummary template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getRelationshipHeader

      public ElementHeader getRelationshipHeader()
      Return the element header associated with the relationship.
      Returns:
      element header object

    • setRelationshipHeader

      public void setRelationshipHeader(ElementHeader relationshipHeader)
      Set up the element header associated with the relationship.
      Parameters:
      relationshipHeader - element header object

    • 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 Map<String,String> getRelationshipProperties()
      Return details of the relationship
      Returns:
      relationship properties

    • setRelationshipProperties

      public void setRelationshipProperties(Map<String,String> relationshipProperties)
      Set up relationship properties
      Parameters:
      relationshipProperties - relationship properties

    • getRelatedElement

      public MetadataElementSummary getRelatedElement()
      Return the element header associated with end 1 of the relationship.
      Returns:
      element stub object

    • setRelatedElement

      public void setRelatedElement(MetadataElementSummary relatedElement)
      Set up the element header associated with end 1 of the relationship.
      Parameters:
      relatedElement - element stub object

    • getRelatedElementAtEnd1

      public boolean getRelatedElementAtEnd1()
      Return whether the element is at end 1 of the relationship.
      Returns:
      boolean

    • setRelatedElementAtEnd1

      public void setRelatedElementAtEnd1(boolean relatedElementAtEnd1)
      Set up whether the element is at end 1 of the relationship.
      Parameters:
      relatedElementAtEnd1 - boolean

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code