Class SearchStringRequestBody

Direct Known Subclasses:
GlossarySearchStringRequestBody

public class SearchStringRequestBody extends EffectiveTimeQueryRequestBody
SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression to use as a search string.
  • Constructor Details

    • SearchStringRequestBody

      public SearchStringRequestBody()
      Default constructor
    • SearchStringRequestBody

      public SearchStringRequestBody(SearchStringRequestBody template)
      Copy/clone constructor
      Parameters:
      template - object to copy
  • Method Details

    • getSearchString

      public String getSearchString()
      Return the search request.
      Returns:
      regEx expression
    • setSearchString

      public void setSearchString(String searchString)
      Set up the search.
      Parameters:
      searchString - regEx expression
    • getSearchStringParameterName

      public String getSearchStringParameterName()
      Return the search string parameter name.
      Returns:
      string name
    • setSearchStringParameterName

      public void setSearchStringParameterName(String searchStringParameterName)
      Set up the search string parameter name.
      Parameters:
      searchStringParameterName - string name
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class EffectiveTimeQueryRequestBody
      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 EffectiveTimeQueryRequestBody
      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 EffectiveTimeQueryRequestBody
      Returns:
      int hash code