Package org.odpi.openmetadata.viewservices.glossarybrowser.rest

Class GlossarySearchStringRequestBody

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody
org.odpi.openmetadata.viewservices.glossarybrowser.rest.GlossarySearchStringRequestBody
All Implemented Interfaces:
Serializable
public class GlossarySearchStringRequestBody extends org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody
GlossarySearchStringRequestBody is the request body structure used on GlossaryCategory/Term REST API calls that passes a regular expression to use as a search string and the scope of the results can be optionally restricted by glossary.
See Also:

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getGlossaryGUID()
    Return the unique identifier of the glossary scope.
    List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus>
    getLimitResultsByStatus()
    Return the list of statuses to return (null for all).
    int
    hashCode()
    Create a hash code for this element type.
    void
    setGlossaryGUID(String glossaryGUID)
    Set up the unique identifier of the glossary scope.
    void
    setLimitResultsByStatus(List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> limitResultsByStatus)
    Set up the list of statuses to return (null for all).
    String
    toString()
    Standard toString method.

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

    getEffectiveTime, getSearchString, getSearchStringParameterName, setEffectiveTime, setSearchString, setSearchStringParameterName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GlossarySearchStringRequestBody

      public GlossarySearchStringRequestBody()
      Default constructor

    • GlossarySearchStringRequestBody

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

  • Method Details

    • getGlossaryGUID

      public String getGlossaryGUID()
      Return the unique identifier of the glossary scope.
      Returns:
      string guid

    • setGlossaryGUID

      public void setGlossaryGUID(String glossaryGUID)
      Set up the unique identifier of the glossary scope.
      Parameters:
      glossaryGUID - string

    • getLimitResultsByStatus

      public List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> getLimitResultsByStatus()
      Return the list of statuses to return (null for all).
      Returns:
      list of statuses (terms only)

    • setLimitResultsByStatus

      public void setLimitResultsByStatus(List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> limitResultsByStatus)
      Set up the list of statuses to return (null for all).
      Parameters:
      limitResultsByStatus - list of statuses (terms only)

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody
      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 org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody
      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 org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody
      Returns:
      int hash code