Console Webservice API

PagingInfo

Other API in Package

Console

Console System

Internal Console

Method Summary
String get(String property)

Returns the specified value from the PagingInfo data.

Integer getCurrentPage()

Returns the number of the current page. Only set if DataViewFilter.filterByPage has been called.

Data getData()

Returns a Data object with information from this paging info.

Integer getFirstPage()

Returns the page number of the first page. Only set if DataViewFilter.filterByPage has been called.

Integer getLastPage()

Returns the page number of the last page. Only set if DataViewFilter.filterByPage has been called.

Integer getNextPage()

Returns the page number of the next page. Only set if DataViewFilter.filterByPage has been called.

Integer getPageCount()

Returns the total page count. Only set if DataViewFilter.filterByPage has been called.

Integer getPreviousPage()

Returns the page number of the previous page. Only set if DataViewFilter.filterByPage has been called.

String getQueryString()

Returns all non default properties (those you've added to Data) as a querystring.

String getQueryString(String action, String pageNumberVariable, int pageNumber)

Returns all non default properties (those you've added to Data) as a querystring with action and pageNumber information.

Integer getTotalRecordCount()

Returns the total number of records matching the filter.

Boolean hasNextPage()

Returns true if there is a next page. Only set if DataViewFilter.filterByPage has been called.

Boolean hasPreviousPage()

Returns true if there is a previous page. Only set if DataViewFilter.filterByPage has been called.

boolean isFast()

Returns true if fast paging is enabled.

String toString()

Returns a description of this object.

Method Detail


String get(String property)

Returns the specified value from the PagingInfo data.

Parameters:

  • String   property

Returns:  String

Since: 10-26-2010

top

Integer getCurrentPage()

Returns the number of the current page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Integer

Since: 06-05-2009

top

Data getData()

Returns a Data object with information from this paging info.

Returns:  Data

Since: 01-19-2009

top

Integer getFirstPage()

Returns the page number of the first page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Integer

Since: 05-06-2009

top

Integer getLastPage()

Returns the page number of the last page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Integer

Since: 05-06-2009

top

Integer getNextPage()

Returns the page number of the next page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Integer

Since: 05-06-2009

top

Integer getPageCount()

Returns the total page count. Only set if DataViewFilter.filterByPage has been called.

Returns:  Integer

Since: 05-06-2009

top

Integer getPreviousPage()

Returns the page number of the previous page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Integer

Since: 05-06-2009

top

String getQueryString()

Returns all non default properties (those you've added to Data) as a querystring.

Returns:  String

Since: 10-26-2010

top

String getQueryString(String action, String pageNumberVariable, int pageNumber)

Returns all non default properties (those you've added to Data) as a querystring with action and pageNumber information.

Parameters:

  • String   action
  • String   pageNumberVariable
  • int   pageNumber

Returns:  String

Since: 10-26-2010

top

Integer getTotalRecordCount()

Returns the total number of records matching the filter.

Returns:  Integer

Since: 05-24-2024

top

Boolean hasNextPage()

Returns true if there is a next page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Boolean

Since: 05-06-2009

top

Boolean hasPreviousPage()

Returns true if there is a previous page. Only set if DataViewFilter.filterByPage has been called.

Returns:  Boolean

Since: 05-06-2009

top

boolean isFast()

Returns true if fast paging is enabled.

Returns:  boolean

Since: 06-20-2024

top

String toString()

Returns a description of this object.

Returns:  String

Since: 05-18-2009

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM