Interface PageRequest

All Known Subinterfaces:
RepositoryCommand
All Known Implementing Classes:
AbstractQueryCommand, AbstractReportQueryCommand, AbstractRepositoryCommand, AttributeContainerQueryCommand, BasicFetchPagingRepositoryCommand, BasicQueryCommand, BasicReportQueryCommand, FindPersistentEntityCommand, PersistedReportQueryCommand

public interface PageRequest
This interface specifies the parameters assocatied with a paging request.

Supported API: true

Extendable: false
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Label for the attribute; Number of items for the page.
    static final String
    Label for the attribute; Offset of the page.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Gets the value of the attribute: COUNT.
    int
    Gets the value of the attribute: OFFSET.
    void
    setCount(int a_Count)
    Sets the value of the attribute: COUNT.
    void
    setOffset(int a_Offset)
    Sets the value of the attribute: OFFSET.
  • Field Details

    • OFFSET

      static final String OFFSET
      Label for the attribute; Offset of the page.

      Supported API: true
      See Also:
    • COUNT

      static final String COUNT
      Label for the attribute; Number of items for the page.

      Supported API: true
      See Also:
  • Method Details

    • getOffset

      int getOffset()
      Gets the value of the attribute: OFFSET. Offset of the page.

      Supported API: true
      Returns:
      int
    • setOffset

      void setOffset(int a_Offset) throws WTPropertyVetoException
      Sets the value of the attribute: OFFSET. Offset of the page.

      Supported API: true
      Parameters:
      a_Offset -
      Throws:
      WTPropertyVetoException
    • getCount

      int getCount()
      Gets the value of the attribute: COUNT. Number of items for the page.

      Supported API: true
      Returns:
      int
    • setCount

      void setCount(int a_Count) throws WTPropertyVetoException
      Sets the value of the attribute: COUNT. Number of items for the page.

      Supported API: true
      Parameters:
      a_Count -
      Throws:
      WTPropertyVetoException