Console API

CellFilter

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
CellFilter addAnd()

Adds an 'AND' clause to the filter.
CellFilter addOr()

Adds an 'OR' clause to the filter.
CellFilter ascendDate()

Sorts the result ascending by date
CellFilter ascendId()

Sorts the result ascending by id
CellFilter ascendName()

Sorts the result ascending by name
CellFilter ascendSort()

Sorts the result ascending by sortOrder
CellFilter beginGroup()

Adds a group clause to the filter.
CellFilter descendDate()

Sorts the result descending by date
CellFilter descendId()

Sorts the result descending by id
CellFilter descendName()

Sorts the result descending by name
CellFilter descendSort()

Sorts the result descending by sortOrder
CellFilter endGroup()

Ends a group clause.
CellFilter greaterThanDate(Date date)

Filters greater than Date.
CellFilter greaterThanExtra(String extra)

Filters greater than extra.
CellFilter greaterThanName(String name)

Filters greater than name.
CellFilter greaterThanOrEqualDate(Date date)

Filters greater than or equal to Date.
CellFilter greaterThanOrEqualExtra(String extra)

Filters greater than or equal to extra.
CellFilter greaterThanOrEqualName(String name)

Filters greater than or equal to name.
CellFilter greaterThanOrEqualSortOrder(String sortOrder)

Filters greater than or equal to sort order.
CellFilter greaterThanOrEqualStatus(String status)

Filters greater than or equal to status.
CellFilter greaterThanSortOrder(String sortOrder)

Filters greater than sort order.
CellFilter greaterThanStatus(String status)

Filters greater than status.
CellFilter lessThanDate(Date date)

Filters less than Date.
CellFilter lessThanExtra(String extra)

Filters less than extra.
CellFilter lessThanName(String name)

Filters less than name.
CellFilter lessThanOrEqualDate(Date date)

Filters less than or equal Date.
CellFilter lessThanOrEqualExtra(String extra)

Filters less than or equal to extra.
CellFilter lessThanOrEqualName(String name)

Filters less than or equal to name.
CellFilter lessThanOrEqualSortOrder(String sortOrder)

Filters less than or equal to sort order.
CellFilter lessThanOrEqualStatus(String status)

Filters less than or equal to status.
CellFilter lessThanSortOrder(String sortOrder)

Filters less than sort order.
CellFilter lessThanStatus(String status)

Filters less than status.
CellFilter likeExtra(String extra)

Filters like extra. Default search is %extra%.
CellFilter likeName(String name)

Filters like name. Default search is %name%.
CellFilter likeStatus(String status)

Filters like status. Default search is %status%.
CellFilter notDate(Date date)

Filters not Date.
CellFilter notDateRange(Date startDate, Date endDate)

Filters by outside of date range.
CellFilter notExtra(String extra)

Filters not extra.
CellFilter notId(String cellId)

Filters for cells without the specified cellId.
CellFilter notName(String name)

Filters not name.
CellFilter notParent(Cell parentCell)

Filters by not parent cell Id.
CellFilter notProfileId(String profileId)

Filters by not profileId.
CellFilter notSlice(String slice)

Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.
CellFilter notSortOrder(String sortOrder)

Filters not equal to sortOrder.
CellFilter notStatus(String status)

Filters not status.
CellFilter reset()

Removes all criteria from the filter.
CellFilter setOffset(long offset)

Sets the page offset. Use 0 for the first record.
CellFilter setPageSize(int pageSize)

Sets the page size. Default is 100, minimum is 1 and maximum is 100,000.
  setQueryTimeout(int timeout)

Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
String toString()

Returns a description of this object.
CellFilter withDate(Date date)

Filters by date.
CellFilter withDateRange(Date startDate, Date endDate)

Filters by date range.
CellFilter withExtra(String extra)

Filters by extra.
CellFilter withId(String cellId)

Filters for cells with the specified cellId.
CellFilter withName(String name)

Filters by name.
CellFilter withParent(Cell parentCell)

Filters by parent cell Id.
CellFilter withProfileId(String profileId)

Filters by profileId.
CellFilter withSlice(String slice)

Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.
CellFilter withSortOrder(String sortOrder)

Filters with sort order.
CellFilter withStatus(String status)

Filters by status.

Method Detail

CellFilter addAnd()

Adds an 'AND' clause to the filter.

Returns:  CellFilter

Since: 08-12-2019

top
CellFilter addOr()

Adds an 'OR' clause to the filter.

Returns:  CellFilter

Since: 08-12-2019

top
CellFilter ascendDate()

Sorts the result ascending by date

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter ascendId()

Sorts the result ascending by id

Returns:  CellFilter

Since: 08-20-2019

top
CellFilter ascendName()

Sorts the result ascending by name

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter ascendSort()

Sorts the result ascending by sortOrder

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter beginGroup()

Adds a group clause to the filter.

Returns:  CellFilter

Since: 08-12-2019

top
CellFilter descendDate()

Sorts the result descending by date

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter descendId()

Sorts the result descending by id

Returns:  CellFilter

Since: 08-20-2019

top
CellFilter descendName()

Sorts the result descending by name

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter descendSort()

Sorts the result descending by sortOrder

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter endGroup()

Ends a group clause.

Returns:  CellFilter

Since: 08-12-2019

top
CellFilter greaterThanDate(Date date)

Filters greater than Date.

Parameters:

  • Date   date Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanExtra(String extra)

Filters greater than extra.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanName(String name)

Filters greater than name.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanOrEqualDate(Date date)

Filters greater than or equal to Date.

Parameters:

  • Date   date Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanOrEqualExtra(String extra)

Filters greater than or equal to extra.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanOrEqualName(String name)

Filters greater than or equal to name.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanOrEqualSortOrder(String sortOrder)

Filters greater than or equal to sort order.

Parameters:

  • String   sortOrder Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanOrEqualStatus(String status)

Filters greater than or equal to status.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanSortOrder(String sortOrder)

Filters greater than sort order.

Parameters:

  • String   sortOrder Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter greaterThanStatus(String status)

Filters greater than status.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanDate(Date date)

Filters less than Date.

Parameters:

  • Date   date Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanExtra(String extra)

Filters less than extra.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanName(String name)

Filters less than name.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanOrEqualDate(Date date)

Filters less than or equal Date.

Parameters:

  • Date   date Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanOrEqualExtra(String extra)

Filters less than or equal to extra.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanOrEqualName(String name)

Filters less than or equal to name.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanOrEqualSortOrder(String sortOrder)

Filters less than or equal to sort order.

Parameters:

  • String   sortOrder Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanOrEqualStatus(String status)

Filters less than or equal to status.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanSortOrder(String sortOrder)

Filters less than sort order.

Parameters:

  • String   sortOrder Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter lessThanStatus(String status)

Filters less than status.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter likeExtra(String extra)

Filters like extra. Default search is %extra%.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 08-23-2019

top
CellFilter likeName(String name)

Filters like name. Default search is %name%.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 08-23-2019

top
CellFilter likeStatus(String status)

Filters like status. Default search is %status%.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 08-23-2019

top
CellFilter notDate(Date date)

Filters not Date.

Parameters:

  • Date   date Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notDateRange(Date startDate, Date endDate)

Filters by outside of date range.

Parameters:

  • Date   startDate Required parameter.
  • Date   endDate Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notExtra(String extra)

Filters not extra.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notId(String cellId)

Filters for cells without the specified cellId.

Parameters:

  • String   cellId Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notName(String name)

Filters not name.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notParent(Cell parentCell)

Filters by not parent cell Id.

Parameters:

  • Cell   parentCell Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notProfileId(String profileId)

Filters by not profileId.

Parameters:

  • String   profileId Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notSlice(String slice)

Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.

Parameters:

  • String   slice Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notSortOrder(String sortOrder)

Filters not equal to sortOrder.

Parameters:

  • String   sortOrder Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter notStatus(String status)

Filters not status.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter reset()

Removes all criteria from the filter.

Returns:  CellFilter

Since: 08-12-2019

top
CellFilter setOffset(long offset)

Sets the page offset. Use 0 for the first record.

Parameters:

  • long   offset  - Use 0 for no offset. Required parameter.

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter setPageSize(int pageSize)

Sets the page size. Default is 100, minimum is 1 and maximum is 100,000.

Parameters:

  • int   pageSize Required parameter.

Returns:  CellFilter

Since: 07-25-2019

top
setQueryTimeout(int timeout)

Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.

Parameters:

  • int   timeout

Since: 08-23-2019

top
String toString()

Returns a description of this object.

Returns:  String

Since: 07-25-2019

top
CellFilter withDate(Date date)

Filters by date.

Parameters:

  • Date   date Required parameter.

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter withDateRange(Date startDate, Date endDate)

Filters by date range.

Parameters:

  • Date   startDate Required parameter.
  • Date   endDate Required parameter.

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter withExtra(String extra)

Filters by extra.

Parameters:

  • String   extra Required parameter.

Returns:  CellFilter

Since: 08-09-2019

top
CellFilter withId(String cellId)

Filters for cells with the specified cellId.

Parameters:

  • String   cellId Required parameter.

Returns:  CellFilter

Since: 10-03-2019

top
CellFilter withName(String name)

Filters by name.

Parameters:

  • String   name Required parameter.

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter withParent(Cell parentCell)

Filters by parent cell Id.

Parameters:

  • Cell   parentCell Required parameter.

Returns:  CellFilter

Since: 08-19-2019

top
CellFilter withProfileId(String profileId)

Filters by profileId.

Parameters:

  • String   profileId Required parameter.

Returns:  CellFilter

Since: 07-25-2019

top
CellFilter withSlice(String slice)

Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.

Parameters:

  • String   slice Required parameter.

Returns:  CellFilter

Since: 08-13-2019

top
CellFilter withSortOrder(String sortOrder)

Filters with sort order.

Parameters:

  • String   sortOrder Required parameter.

Returns:  CellFilter

Since: 10-10-2024

top
CellFilter withStatus(String status)

Filters by status.

Parameters:

  • String   status Required parameter.

Returns:  CellFilter

Since: 07-25-2019

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