Internal Console API

InternalStatBuilder

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 count(String query)

Returns the results for the query with all dates.

String count(String query, Date startDate, Date endDate)

Returns the results for the query and date range.

InternalStatBuilder filterEnterpriseId(String enterpriseId)

Isolates query to the specified Enterprise.

InternalStatBuilder filterPalId(String palId)

Isolates query to the specified Pal.

InternalStatBuilder filterProfileId(String profileId)

Isolates query to the specified Profile.

DataList getColumns(String query)

Returns a list of column names for the query.

DataList getOptions()

Returns a list of possible queries.

DataList getPalHistory(String name, Date startDate, Date endDate, String type)

Obtains the runtime or development history of the bound Pal. See setPal.

DataList getRecords(String query, Date startDate, Date endDate, int firstPage, int pageSize)

Returns a list of records for query of type 'list'. For column names, see getColumns(String query)

DataList getRecords(String query, int firstPage, int pageSize)

Returns a list of records for query of type 'list' for all dates. For column names, see getColumns(String query)

InternalStatBuilder include(String query, String name, Date startDate, Date endDate)

Include the specified query with date range and identify its result by 'name'. Used on conjunction with list().

DataList list()

Returns a list of records. See include().

InternalStatBuilder reset()

Resets the builder.

  setDateFormat(String pattern)

Sets the date pattern for displaying dates.

  setDateTimeFormat(String pattern)

Sets the date pattern for displaying dates with time.

String toString()

Returns a description of this object.

Method Detail


String count(String query)

Returns the results for the query with all dates.

Parameters:

  • String   query Required parameter.

Returns:  String

Since: 11-12-2010

top

String count(String query, Date startDate, Date endDate)

Returns the results for the query and date range.

Parameters:

  • String   query Required parameter.
  • Date   startDate Required parameter.
  • Date   endDate Required parameter.

Returns:  String

Since: 11-12-2010

top

InternalStatBuilder filterEnterpriseId(String enterpriseId)

Isolates query to the specified Enterprise.

Parameters:

  • String   enterpriseId Required parameter.

Returns:  InternalStatBuilder

Since: 05-13-2014

top

InternalStatBuilder filterPalId(String palId)

Isolates query to the specified Pal.

Parameters:

  • String   palId Required parameter.

Returns:  InternalStatBuilder

Since: 09-17-2012

top

InternalStatBuilder filterProfileId(String profileId)

Isolates query to the specified Profile.

Parameters:

  • String   profileId Required parameter.

Returns:  InternalStatBuilder

Since: 09-17-2012

top

DataList getColumns(String query)

Returns a list of column names for the query.

Parameters:

  • String   query Required parameter.

Returns:  DataList


DataList Name: columns
DataList Fields: name

Since: 02-18-2011

top

DataList getOptions()

Returns a list of possible queries.

Returns:  DataList


DataList Name: options
DataList Fields: name, description, type

Since: 11-12-2010

top

DataList getPalHistory(String name, Date startDate, Date endDate, String type)

Obtains the runtime or development history of the bound Pal. See setPal.

Parameters:

  • String   name  - Desired name of list. Required parameter.
  • Date   startDate Required parameter.
  • Date   endDate Required parameter.
  • String   type Required parameter. Allowed values: workflow, builder, all.

Returns:  DataList

Since: 09-17-2012

top

DataList getRecords(String query, Date startDate, Date endDate, int firstPage, int pageSize)

Returns a list of records for query of type 'list'. For column names, see getColumns(String query)

Parameters:

  • String   query Required parameter.
  • Date   startDate Required parameter.
  • Date   endDate Required parameter.
  • int   firstPage Required parameter.
  • int   pageSize Required parameter.

Returns:  DataList

Since: 02-18-2011

top

DataList getRecords(String query, int firstPage, int pageSize)

Returns a list of records for query of type 'list' for all dates. For column names, see getColumns(String query)

Parameters:

  • String   query Required parameter.
  • int   firstPage Required parameter.
  • int   pageSize Required parameter.

Returns:  DataList

Since: 02-18-2011

top

InternalStatBuilder include(String query, String name, Date startDate, Date endDate)

Include the specified query with date range and identify its result by 'name'. Used on conjunction with list().

Parameters:

  • String   query Required parameter.
  • String   name Required parameter.
  • Date   startDate Required parameter.
  • Date   endDate Required parameter.

Returns:  InternalStatBuilder

Since: 11-12-2010

top

DataList list()

Returns a list of records. See include().

Returns:  DataList


DataList Name: items
DataList Fields: name, count

Since: 11-12-2010

top

InternalStatBuilder reset()

Resets the builder.

Returns:  InternalStatBuilder

Since: 11-12-2010

top

setDateFormat(String pattern)

Sets the date pattern for displaying dates.

Parameters:

  • String   pattern

Since: 02-18-2011

top

setDateTimeFormat(String pattern)

Sets the date pattern for displaying dates with time.

Parameters:

  • String   pattern

Since: 11-10-2011

top

String toString()

Returns a description of this object.

Returns:  String

Since: 11-12-2010

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 22, 2024 11:54 AM