Package wt.query

Class PageableQuerySpec

java.lang.Object
wt.query.PageableQuerySpec
All Implemented Interfaces:
Externalizable, Serializable, StatementSpec
Direct Known Subclasses:
BasicPageableQuerySpec, PagingSessionSpec
public abstract class PageableQuerySpec extends Object implements StatementSpec, Externalizable
This abstract class provides common APIs and functionality for queries that support paging. The primary statement is the source of the results that can be paged. The offset and range values specify the page offset and size.

Supported API: true

Extendable: false
See Also:

  • Field Summary

    Fields inherited from interface wt.pds.StatementSpec

    ADVANCED_QUERY_ENABLED, USE_BIND

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getOffset()
    Gets the value of the attribute: offset; Paging offset into the original result set.
    int
    getRange()
    Gets the value of the attribute: range; Paging range that specifies the number of requested elements.
    boolean
    isAdvancedQueryEnabled()
    Gets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
    boolean
    isUseBind()
    Gets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.
    void
    setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)
    Sets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
    void
    setLocale(Locale a_locale)
    Set the client locale.
    void
    setOffset(int a_Offset)
    Sets the value of the attribute: offset; Paging offset into the original result set.
    void
    setRange(int a_Range)
    Sets the value of the attribute: range; Paging range that specifies the number of requested elements.
    void
    setUseBind(boolean a_UseBind)
    Sets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getOffset

      public int getOffset()
      Gets the value of the attribute: offset; Paging offset into the original result set.

      Supported API: true
      Returns:
      int

    • setOffset

      public void setOffset(int a_Offset) throws WTPropertyVetoException
      Sets the value of the attribute: offset; Paging offset into the original result set.

      Supported API: true
      Parameters:
      a_Offset -
      Throws:
      WTPropertyVetoException

    • getRange

      public int getRange()
      Gets the value of the attribute: range; Paging range that specifies the number of requested elements. If the range is less than or equal to zero, then all elements are returned.

      Supported API: true
      Returns:
      int

    • setRange

      public void setRange(int a_Range) throws WTPropertyVetoException
      Sets the value of the attribute: range; Paging range that specifies the number of requested elements. If the range is less than or equal to zero, then all elements are returned.

      Supported API: true
      Parameters:
      a_Range -
      Throws:
      WTPropertyVetoException

    • isAdvancedQueryEnabled

      public boolean isAdvancedQueryEnabled()
      Gets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled. By design, this attribute is transient and its value is not passed between Java Virtual Machine (JVM) processes. The value should be set within the same JVM process that executes the statement.

      Supported API: true
      Specified by:
      isAdvancedQueryEnabled in interface StatementSpec
      Returns:
      boolean

    • setAdvancedQueryEnabled

      public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)
      Sets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled. By design, this attribute is transient and its value is not passed between Java Virtual Machine (JVM) processes. The value should be set within the same JVM process that executes the statement.

      Supported API: true
      Specified by:
      setAdvancedQueryEnabled in interface StatementSpec
      Parameters:
      a_AdvancedQueryEnabled -

    • setLocale

      public void setLocale(Locale a_locale) throws WTException
      Set the client locale.

      Supported API: true
      Specified by:
      setLocale in interface StatementSpec
      Parameters:
      a_locale -
      Throws:
      WTException

    • isUseBind

      public boolean isUseBind()
      Gets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.

      Supported API: true
      Specified by:
      isUseBind in interface StatementSpec
      Returns:
      boolean

    • setUseBind

      public void setUseBind(boolean a_UseBind) throws WTPropertyVetoException
      Sets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.

      Supported API: true
      Specified by:
      setUseBind in interface StatementSpec
      Parameters:
      a_UseBind -
      Throws:
      WTPropertyVetoException