Package org.odpi.openmetadata.frameworkservices.gaf.rest

Class NewRelatedElementsRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.rest.MetadataSourceRequestBody
org.odpi.openmetadata.frameworkservices.gaf.rest.UpdateRequestBody
org.odpi.openmetadata.frameworkservices.gaf.rest.NewRelatedElementsRequestBody
public class NewRelatedElementsRequestBody extends UpdateRequestBody
NewRelatedElementsRequestBody provides a structure for passing the properties for a new relationship between metadata elements.

  • Constructor Details

    • NewRelatedElementsRequestBody

      public NewRelatedElementsRequestBody()
      Default constructor

    • NewRelatedElementsRequestBody

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

  • Method Details

    • getTypeName

      public String getTypeName()
      Return the open metadata type name for the new metadata element.
      Returns:
      string name

    • setTypeName

      public void setTypeName(String typeName)
      Set up the open metadata type name for the new metadata element.
      Parameters:
      typeName - string name

    • setMetadataElement1GUID

      public void setMetadataElement1GUID(String metadataElement1GUID)
      Set up the unique identifier of the metadata element at end 1 of the relationship.
      Parameters:
      metadataElement1GUID - String guid

    • getMetadataElement1GUID

      public String getMetadataElement1GUID()
      Returns the unique identifier of the metadata element at end 1 of the relationship.
      Returns:
      string guid

    • setMetadataElement2GUID

      public void setMetadataElement2GUID(String metadataElement2GUID)
      Set up the unique identifier of the metadata element at end 2 of the relationship.
      Parameters:
      metadataElement2GUID - String guid

    • getMetadataElement2GUID

      public String getMetadataElement2GUID()
      Returns the unique identifier of the metadata element at end 2 of the relationship.
      Returns:
      string guid

    • getEffectiveFrom

      public Date getEffectiveFrom()
      Return the date/time that this new relationship becomes effective in the governance program (null means immediately).
      Returns:
      date object

    • setEffectiveFrom

      public void setEffectiveFrom(Date effectiveFrom)
      Set up the date/time that this new relationship becomes effective in the governance program (null means immediately).
      Parameters:
      effectiveFrom - date object

    • getEffectiveTo

      public Date getEffectiveTo()
      Return the date/time when the new relationship is no longer effective in the governance program (null means until deleted).
      Returns:
      date object

    • setEffectiveTo

      public void setEffectiveTo(Date effectiveTo)
      Set up the date/time when the new relationship is no longer effective in the governance program (null means until deleted).
      Parameters:
      effectiveTo - date object

    • getProperties

      public ElementProperties getProperties()
      Return the properties for the new relationship.
      Returns:
      list of properties

    • setProperties

      public void setProperties(ElementProperties properties)
      Set up the properties for the new relationship.
      Parameters:
      properties - list of properties

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class UpdateRequestBody
      Returns:
      list of properties and their values.

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class UpdateRequestBody
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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