Interface IQuery

All Known Implementing Classes:
BaseQuery, CountQuery, IndexedQuery, SeekQuery, SimpleQuery

public interface IQuery
Represents a query on an entity. All different queries should implement this contract.
  • Method Details

    • getType

      QueryType getType()
      Gets the query type.
      Returns:
      The query type.
    • getFilter

      FieldFilter getFilter()
      Gets the query filter.
      Returns:
      The query filter.
    • setFilter

      void setFilter​(FieldFilter value)
      The query filter.
      Parameters:
      value - The query filter.
    • getSort

      Sort getSort()
      Gets the query sorting options.
      Returns:
      The query sorting options.
    • setSort

      void setSort​(Sort value)
      Sets the query sorting options.
      Parameters:
      value - The query sorting options.
    • getIndex

      int getIndex()
      Gets the result starting index.
      Returns:
      The result starting index.
    • setIndex

      void setIndex​(int value)
      Sets the result starting index.
      Parameters:
      value - The result starting index.
    • getPageSize

      int getPageSize()
      Gets the results page size.
      Returns:
      The result page size.
    • setPageSize

      void setPageSize​(int value)
      Sets the results page size.
      Parameters:
      value - The results page size.
    • getToken

      Object getToken()
      Gets the query token. The token may hold context used to represent current state with back end services.
      Returns:
      The query token.
    • setToken

      void setToken​(Object value)
      Sets the query token.
      Parameters:
      value - The query token.
    • getSeekOperation

      SeekOperation getSeekOperation()
      Gets or sets the seek operation that needs to be performed.
      Returns:
      The seek operation that needs to be performed.
    • setSeekOperation

      void setSeekOperation​(SeekOperation value)
      Sets the seek operation that needs to be performed.
      Parameters:
      value - The seek operation that needs to be performed.