Package wt.query

Class BasicPageableQuerySpec

java.lang.Object
wt.query.PageableQuerySpec
wt.query.BasicPageableQuerySpec
All Implemented Interfaces:
Externalizable, Serializable, StatementSpec, PageableSessionQuerySpec
public class BasicPageableQuerySpec extends PageableQuerySpec implements PageableSessionQuerySpec, Externalizable
This class provides a standard implementation for establishing a paging session. It also extends the PageableQuerySpec and can be used to retrieve an intial result page.

Supported API: true

Extendable: false
See Also:

  • Method Details

    • getGroupFromIndex

      public int getGroupFromIndex()
      Gets the value of the attribute: groupFromIndex; Specifies a FromIndex from the snapshor query that will be used to group results for paging.

      Supported API: true
      Specified by:
      getGroupFromIndex in interface PageableSessionQuerySpec
      Returns:
      int

    • setGroupFromIndex

      public void setGroupFromIndex(int a_GroupFromIndex) throws WTPropertyVetoException
      Sets the value of the attribute: groupFromIndex; Specifies a FromIndex from the snapshor query that will be used to group results for paging.

      Supported API: true
      Specified by:
      setGroupFromIndex in interface PageableSessionQuerySpec
      Parameters:
      a_GroupFromIndex -
      Throws:
      WTPropertyVetoException

    • getPageThreshold

      public int getPageThreshold()
      Gets the value of the attribute: pageThreshold; Specifies threshold at which a paging session will be established. If the snapshot query contains fewer items than this threshold, then those items will be returned and no paging session will be established. The default value for this attribute is obtained from the system property "wt.pom.paging.threshold".

      Supported API: true
      Specified by:
      getPageThreshold in interface PageableSessionQuerySpec
      Returns:
      int

    • setPageThreshold

      public void setPageThreshold(int a_PageThreshold) throws WTPropertyVetoException
      Sets the value of the attribute: pageThreshold; Specifies threshold at which a paging session will be established. If the snapshot query contains fewer items than this threshold, then those items will be returned and no paging session will be established. The default value for this attribute is obtained from the system property "wt.pom.paging.threshold".

      Supported API: true
      Specified by:
      setPageThreshold in interface PageableSessionQuerySpec
      Parameters:
      a_PageThreshold -
      Throws:
      WTPropertyVetoException

    • getPrimaryStatement

      public StatementSpec getPrimaryStatement()
      Gets the object for the association that plays role: primaryStatement.

      Supported API: true
      Specified by:
      getPrimaryStatement in interface PageableSessionQuerySpec
      Overrides:
      getPrimaryStatement in class PageableQuerySpec
      Returns:
      StatementSpec

    • setPrimaryStatement

      public void setPrimaryStatement(StatementSpec a_PrimaryStatement) throws WTPropertyVetoException
      Sets the object for the association that plays role: primaryStatement.

      Supported API: true
      Specified by:
      setPrimaryStatement in interface PageableSessionQuerySpec
      Overrides:
      setPrimaryStatement in class PageableQuerySpec
      Parameters:
      a_PrimaryStatement -
      Throws:
      WTPropertyVetoException