Internal Console API

PagingInfo

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

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