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

Class ResultsRequestBody

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
Direct Known Subclasses:
ElementStatusRequestBody, FilterRequestBody, NameRequestBody, SearchStringRequestBody, UseTypeRequestBody
public class ResultsRequestBody extends Object
ResultsRequestBody carries the date/time for a query along with other common search parameters.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    Date
    getAsOfTime()
    Return the repository time that should be used when retrieving metadata.
    Date
    getEffectiveTime()
    Return the date/time to use for the query.
    List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus>
    getLimitResultsByStatus()
    Return the optional list of statuses that should be used to restrict the elements returned by their status.
    org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder
    getSequencingOrder()
    Return the order that results should be returned in.
    String
    getSequencingProperty()
    Return the property that should be used to order the results.
    int
    hashCode()
    Return hash code for this object
    void
    setAsOfTime(Date asOfTime)
    Set up the repository time that should be used when retrieving metadata.
    void
    setEffectiveTime(Date effectiveTime)
    Set up the date/time to use for the query.
    void
    setLimitResultsByStatus(List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus)
    Set up the optional list of statuses that should be used to restrict the elements returned by their status.
    void
    setSequencingOrder(org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder)
    Set up the order that results should be returned in.
    void
    setSequencingProperty(String sequencingProperty)
    Set up the property that should be used to order the results.
    String
    toString()
    JSON-style toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ResultsRequestBody

      public ResultsRequestBody()
      Default constructor

    • ResultsRequestBody

      public ResultsRequestBody(ResultsRequestBody 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

    • getLimitResultsByStatus

      public List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> getLimitResultsByStatus()
      Return the optional list of statuses that should be used to restrict the elements returned by their status. By default, the elements in all non-DELETED statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE, DELETED) to restrict the results to. Null means all status values except DELETED.
      Returns:
      list of statuses or null

    • setLimitResultsByStatus

      public void setLimitResultsByStatus(List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus)
      Set up the optional list of statuses that should be used to restrict the elements returned by their status. By default, the elements in all non-DELETED statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE, DELETED) to restrict the results to. Null means all status values except DELETED.
      Parameters:
      limitResultsByStatus - list of statuses or null

    • getAsOfTime

      public Date getAsOfTime()
      Return the repository time that should be used when retrieving metadata.
      Returns:
      date/time (default null which means now)

    • setAsOfTime

      public void setAsOfTime(Date asOfTime)
      Set up the repository time that should be used when retrieving metadata.
      Parameters:
      asOfTime - date/time (default null which means now)

    • getSequencingProperty

      public String getSequencingProperty()
      Return the property that should be used to order the results.
      Returns:
      property name

    • setSequencingProperty

      public void setSequencingProperty(String sequencingProperty)
      Set up the property that should be used to order the results.
      Parameters:
      sequencingProperty - property name

    • getSequencingOrder

      public org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder getSequencingOrder()
      Return the order that results should be returned in.
      Returns:
      enum

    • setSequencingOrder

      public void setSequencingOrder(org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder)
      Set up the order that results should be returned in.
      Parameters:
      sequencingOrder - enum

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

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