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

Class TemplateRequestBody

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.NewElementRequestBody
org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody
public class TemplateRequestBody extends org.odpi.openmetadata.commonservices.ffdc.rest.NewElementRequestBody
TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TemplateRequestBody()
    Default constructor
    TemplateRequestBody(TemplateRequestBody 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.
    Map<String,String>
    getPlaceholderPropertyValues()
    Return the property values to replace placeholders in the template.
    org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties
    getReplacementProperties()
    Return the properties for the new metadata element.
    String
    getTemplateGUID()
    Returns the unique identifier of the element to use as a template (optional).
    int
    hashCode()
    Return hash code for this object
    void
    setPlaceholderPropertyValues(Map<String,String> placeholderPropertyValues)
    Set up the property values to replace placeholders in the template.
    void
    setReplacementProperties(org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties replacementProperties)
    Set up the properties for the new metadata element.
    void
    setTemplateGUID(String templateGUID)
    Set up the unique identifier of the element to use as a template (optional).

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.NewElementRequestBody

    getAnchorGUID, getIsOwnAnchor, getParentAtEnd1, getParentGUID, getParentRelationshipProperties, getParentRelationshipTypeName, setAnchorGUID, setIsOwnAnchor, setParentAtEnd1, setParentGUID, setParentRelationshipProperties, setParentRelationshipTypeName, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TemplateRequestBody

      public TemplateRequestBody()
      Default constructor

    • TemplateRequestBody

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

  • Method Details

    • getReplacementProperties

      public org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties getReplacementProperties()
      Return the properties for the new metadata element.
      Returns:
      list of properties

    • setReplacementProperties

      public void setReplacementProperties(org.odpi.openmetadata.frameworks.governanceaction.search.ElementProperties replacementProperties)
      Set up the properties for the new metadata element.
      Parameters:
      replacementProperties - list of properties

    • setTemplateGUID

      public void setTemplateGUID(String templateGUID)
      Set up the unique identifier of the element to use as a template (optional).
      Parameters:
      templateGUID - String guid

    • getTemplateGUID

      public String getTemplateGUID()
      Returns the unique identifier of the element to use as a template (optional).
      Returns:
      string guid

    • getPlaceholderPropertyValues

      public Map<String,String> getPlaceholderPropertyValues()
      Return the property values to replace placeholders in the template.
      Returns:
      map of property name to property value

    • setPlaceholderPropertyValues

      public void setPlaceholderPropertyValues(Map<String,String> placeholderPropertyValues)
      Set up the property values to replace placeholders in the template.
      Parameters:
      placeholderPropertyValues - map of property name to property value

    • equals

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

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.commonservices.ffdc.rest.NewElementRequestBody
      Returns:
      int hash code