Console API

DataView

List of Classes

ConsoleController

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

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
AnalyticDataViewFilter createAnalyticFilter()

Returns a new AnalyticSet with no columns selected.

AnalyticDataViewFilter createAnalyticFilter(String[] columns)

Returns a new AnalyticSet with the columns to be selected.

DataViewFilter createFilter()

Returns a new DataViewFilter.

DataViewRecord findRecord(DataViewFilter filter)

Finds the first record matching the criteria of the filter.

DataList getColumns()

Returns a read-only DataList containing column information.

String getName()

Returns the name of this DataSet.

DataViewList getRecords()

Creates a default filter and returns the first 100 records.

DataViewList getRecords(DataViewFilter filter)

Returns records that match the filter criteria. If filter is null, a default filter is created.

DataViewList getRecords(DataViewFilter filter, String name)

Returns records that match the filter criteria and sets the name of the list. Filter can be null.

int getTotalRecordCount(DataViewFilter filter)

Returns the total count of records that match the DataFilter. Returns total count ignoring pageSize.

  setDateFormat(String filter)

Sets the date pattern for displaying dates.

  setDateTimeFormat(String filter)

Sets the date pattern for displaying dates with time.

String toString()

Returns a description of this object.

Method Detail


AnalyticDataViewFilter createAnalyticFilter()

Returns a new AnalyticSet with no columns selected.

Returns:  AnalyticDataViewFilter

Since: 07-10-2008

top

AnalyticDataViewFilter createAnalyticFilter(String[] columns)

Returns a new AnalyticSet with the columns to be selected.

Parameters:

  • String[]   columns

Returns:  AnalyticDataViewFilter

Since: 06-04-2008

top

DataViewFilter createFilter()

Returns a new DataViewFilter.

Returns:  DataViewFilter

Since: 06-04-2008

top

DataViewRecord findRecord(DataViewFilter filter)

Finds the first record matching the criteria of the filter.

Parameters:

Returns:  DataViewRecord

Since: 04-15-2010

top

DataList getColumns()

Returns a read-only DataList containing column information.

Returns:  DataList


DataList Name: columns
DataList Fields: name, type, length, default, notNull, notEmpty, validation, description

Since: 06-04-2008

top

String getName()

Returns the name of this DataSet.

Returns:  String

Since: 06-04-2008

top

DataViewList getRecords()

Creates a default filter and returns the first 100 records.

Returns:  DataViewList

Since: 09-29-2010

top

DataViewList getRecords(DataViewFilter filter)

Returns records that match the filter criteria. If filter is null, a default filter is created.

Parameters:

Returns:  DataViewList

Since: 06-04-2008

top

DataViewList getRecords(DataViewFilter filter, String name)

Returns records that match the filter criteria and sets the name of the list. Filter can be null.

Parameters:

Returns:  DataViewList

Since: 10-28-2009

top

int getTotalRecordCount(DataViewFilter filter)

Returns the total count of records that match the DataFilter. Returns total count ignoring pageSize.

Parameters:

Returns:  int

Since: 10-09-2008

top

setDateFormat(String filter)

Sets the date pattern for displaying dates.

Parameters:

  • String   filter

Since: 01-19-2009

top

setDateTimeFormat(String filter)

Sets the date pattern for displaying dates with time.

Parameters:

  • String   filter

Since: 11-10-2011

top

String toString()

Returns a description of this object.

Returns:  String

Since: 06-04-2008

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