Package org.odpi.openmetadata.commonservices.ffdc.rest

Class NameRequestBody

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody
Direct Known Subclasses:
GlossaryNameRequestBody
public class NameRequestBody extends Object
NameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.

  • Constructor Details

    • NameRequestBody

      public NameRequestBody()
      Default constructor

    • NameRequestBody

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

  • Method Details

    • getEffectiveTime

      public Date getEffectiveTime()
      Return the date/time to use for the query.
      Returns:
      date object

    • setEffectiveTime

      public void setEffectiveTime(Date effectiveTime)
      Set up the date/time to use for the query.
      Parameters:
      effectiveTime - date object

    • getName

      public String getName()
      Return the name for the query request.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the name for the query request.
      Parameters:
      name - string

    • getNameParameterName

      public String getNameParameterName()
      Return the parameter name.
      Returns:
      string name

    • setNameParameterName

      public void setNameParameterName(String nameParameterName)
      Set up the parameter name.
      Parameters:
      nameParameterName - string

    • getNamePropertyName

      public String getNamePropertyName()
      Return the property name from the open metadata types.
      Returns:
      string name

    • setNamePropertyName

      public void setNamePropertyName(String namePropertyName)
      Set up the property name from the open metadata types.
      Parameters:
      namePropertyName - string

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      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 Object
      Returns:
      int hash code