Package org.odpi.openmetadata.viewservices.collectionmanager.rest

Class NewElementRequestBody

java.lang.Object
org.odpi.openmetadata.viewservices.collectionmanager.rest.NewElementRequestBody
Direct Known Subclasses:
NewCollectionRequestBody, NewMetadataElementRequestBody, TemplateRequestBody
public class NewElementRequestBody extends Object
NewElementRequestBody provides a structure for the common properties when creating an element.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NewElementRequestBody()
    Default constructor
    NewElementRequestBody(NewElementRequestBody template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    String
    getAnchorGUID()
    Return the unique identifier of the element that should be the anchor for the new element.
    boolean
    getIsOwnAnchor()
    Return whether this element should be classified as its own anchor or not.
    boolean
    getParentAtEnd1()
    Return which end any parent entity sits on the relationship.
    String
    getParentGUID()
    Return the optional unique identifier for an element that should be connected to the newly created element.
    org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties
    getParentRelationshipProperties()
    Return any properties that should be included in the parent relationship.
    String
    getParentRelationshipTypeName()
    Return the name of the relationship, if any, that should be established between the new element and the parent element.
    int
    hashCode()
    Return hash code for this object
    void
    setAnchorGUID(String anchorGUID)
    Set up the unique identifier of the element that should be the anchor for the new element.
    void
    setIsOwnAnchor(boolean ownAnchor)
    Set up whether this element should be classified as its own anchor or not.
    void
    setParentAtEnd1(boolean parentAtEnd1)
    Set up which end any parent entity sits on the relationship.
    void
    setParentGUID(String parentGUID)
    Set up the optional unique identifier for an element that should be connected to the newly created element.
    void
    setParentRelationshipProperties(org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties parentRelationshipProperties)
    Set up any properties that should be included in the parent relationship.
    void
    setParentRelationshipTypeName(String parentRelationshipTypeName)
    Set up the name of the optional relationship from the newly created element to a parent element.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NewElementRequestBody

      public NewElementRequestBody()
      Default constructor

    • NewElementRequestBody

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

  • Method Details

    • getAnchorGUID

      public String getAnchorGUID()
      Return the unique identifier of the element that should be the anchor for the new element. It is set to null if no anchor, or the Anchors classification is included in the initial classifications.
      Returns:
      string guid

    • setAnchorGUID

      public void setAnchorGUID(String anchorGUID)
      Set up the unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the new collection should be its own anchor.
      Parameters:
      anchorGUID - string guid

    • getIsOwnAnchor

      public boolean getIsOwnAnchor()
      Return whether this element should be classified as its own anchor or not. The default is false.
      Returns:
      boolean

    • setIsOwnAnchor

      public void setIsOwnAnchor(boolean ownAnchor)
      Set up whether this element should be classified as its own anchor or not. The default is false.
      Parameters:
      ownAnchor - boolean

    • getParentGUID

      public String getParentGUID()
      Return the optional unique identifier for an element that should be connected to the newly created element. If this property is specified, parentRelationshipTypeName must also be specified.
      Returns:
      string guid

    • setParentGUID

      public void setParentGUID(String parentGUID)
      Set up the optional unique identifier for an element that should be connected to the newly created element. If this property is specified, parentRelationshipTypeName must also be specified.
      Parameters:
      parentGUID - string guid

    • getParentRelationshipTypeName

      public String getParentRelationshipTypeName()
      Return the name of the relationship, if any, that should be established between the new element and the parent element.
      Returns:
      string type name

    • setParentRelationshipTypeName

      public void setParentRelationshipTypeName(String parentRelationshipTypeName)
      Set up the name of the optional relationship from the newly created element to a parent element.
      Parameters:
      parentRelationshipTypeName - string type name

    • getParentRelationshipProperties

      public org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties getParentRelationshipProperties()
      Return any properties that should be included in the parent relationship.
      Returns:
      element properties

    • setParentRelationshipProperties

      public void setParentRelationshipProperties(org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties parentRelationshipProperties)
      Set up any properties that should be included in the parent relationship.
      Parameters:
      parentRelationshipProperties - element properties

    • getParentAtEnd1

      public boolean getParentAtEnd1()
      Return which end any parent entity sits on the relationship.
      Returns:
      boolean

    • setParentAtEnd1

      public void setParentAtEnd1(boolean parentAtEnd1)
      Set up which end any parent entity sits on the relationship.
      Parameters:
      parentAtEnd1 - boolean

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class Object
      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 Object
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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