Package org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common

Class FindRequest

java.lang.Object
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest
public class FindRequest extends Object
FindRequest is used by the Subject Area OMAS to specify paging information for find calls.

  • Constructor Details

    • FindRequest

      public FindRequest()
      Default constructor

    • FindRequest

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

  • Method Details

    • getSearchCriteria

      public String getSearchCriteria()

    • setSearchCriteria

      public void setSearchCriteria(String searchCriteria)

    • getSequencingProperty

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

    • setSequencingProperty

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

    • getSequencingOrder

      public SequencingOrder getSequencingOrder()
      Return the sequencing order for the results.
      Returns:
      sequencing order enum

    • setSequencingOrder

      public void setSequencingOrder(SequencingOrder sequencingOrder)
      Set up the sequencing order for the results.
      Parameters:
      sequencingOrder - sequencing order enum

    • getStartingFrom

      public int getStartingFrom()
      Return the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
      Returns:
      startingFrom number

    • setStartingFrom

      public void setStartingFrom(int startingFrom)
      Set up the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
      Parameters:
      startingFrom - startingFrom number

    • getPageSize

      public Integer getPageSize()
      Return the maximum number of elements that can be returned on this request.
      Returns:
      page size

    • setPageSize

      public void setPageSize(Integer pageSize)
      Set up the maximum number of elements that can be returned on this request.
      Parameters:
      pageSize - integer number

    • getAsOfTime

      public Date getAsOfTime()
      Get the time at which the find should be issued.
      Returns:
      Date at which the find should be issued

    • setAsOfTime

      public void setAsOfTime(Date asOfTime)
      set up the time at which the find should be made. null means current time.
      Parameters:
      asOfTime - Date at which the find should be issued

    • 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 o)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class 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