Class RelatedMetadataElements

  • All Implemented Interfaces:
    java.io.Serializable

    public class RelatedMetadataElements
    extends ElementControlHeader
    Structure for returning a relationship between two metadata elements.
    See Also:
    Serialized Form
    • Constructor Detail

      • RelatedMetadataElements

        public RelatedMetadataElements()
        Typical Constructor
      • RelatedMetadataElements

        public RelatedMetadataElements​(RelatedMetadataElements 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 Detail

      • getRelationshipGUID

        public java.lang.String getRelationshipGUID()
        Return the unique id for the relationship .
        Returns:
        String unique id
      • setRelationshipGUID

        public void setRelationshipGUID​(java.lang.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 java.util.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​(java.util.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 java.util.Date getEffectiveToTime()
        Return the date/time that this instance should no longer be used.
        Returns:
        Date object
      • setEffectiveToTime

        public void setEffectiveToTime​(java.util.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 java.lang.String getElementGUIDAtEnd1()
        Return the unique identifier of the element at end 1 of the relationship.
        Returns:
        related element
      • setElementGUIDAtEnd1

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

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

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

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class ElementControlHeader
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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