Web API

PalActivationKeyInfo

Other API in Package

User

Internal Tunnel

Tunnel

List of Classes

WebController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

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

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

NavigatorResponse

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Pin

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Response

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Method Summary
int getAccessPeriod()

Returns the access period in months. 0 means not used. -1 means infinite (no ending).

int getArchivePeriod()

Returns the archive period in months. 0 means not used. -1 means infinite (no ending).

Data getData()

Returns a Data object containing information on this activation key.

int getEmailExpirePeriod()

Returns the email expiration period in weeks.

int getEmailLimit()

Returns max number of emails that workflow can send per run.

int getExecutionPeriod()

Returns the execution period in months.

double getExpandFee()

Returns the fee per MB for expanding a transaction size.

String getId()

Returns the ID of the key

int getMaxAdhocDocuments()
⚠Deprecated since 10-27-2016. No replacement

Returns the maximum number of adhoc documents that can be added to the transaction.

int getMaxAudioLength()

Returns the maximum audio recording length in minutes.

int getMaxConsolePacketSize()

Returns the ConsolePacket size in kilobytes.

int getMaxDocumentSize()

Returns the maximum size an empty Document can be (in kilobytes).

int getMaxExportSize()

Returns the maximum export size (in kilobytes).

int getMaxFileSize()

Returns the maximum size of any Pal file (in kilobytes).

int getMaxHtmlDocuments()

Returns the maximum number of html documents that can be added to the transaction.

int getMaxPageSize()

Returns max page size of a dataset query.

int getMaxPalSize()

Returns the maximum size of the Pal (in kilobytes).

int getMaxPdfDocuments()

Returns the maximum number of pdf documents that can be added to the transaction.

int getMaxPdfPageCount()

Returns the max page count for PDFs.

int getMaxRoles()

Returns the maximum number of different roles allowed in the transaction.

int getMaxSignatures()

Returns the maximum number of signatures that can exist in the transaction.

int getMaxTransactionSize()

Returns the maximum transaction size in kilobytes.

int getMaxUploadSize()

Returns the max allowed upload size in kilobytes.

int getMaxUserPacketSize()

Returns the ProfilePacket size in kilobytes.

int getMaxWizards()

Returns the maximum number of wizards that can be added to the transaction.

String getName()

Returns the name of the this Activation.

String getStatus()

Returns the status of the key.

int getTimeout()

Returns the max allowed workflow timeout in seconds. See Monitor.setTimeout

int getTxJobExpirePeriod()

Returns the transaction job expiration period in weeks.

boolean isAudioEnabled()

Returns true if audio recording is enabled.

boolean isAuthEnabled()

Returns true if this activation key permits authentication (login) processes.

boolean isConsoleEnabled()

Returns true if Console workflow is enabled.

boolean isConsoleSystemEnabled()

Returns true if the ability to run Console System workflow is enabled.

boolean isConsoleWebServiceEnabled()

Returns true if the ability to run Console Web Service workflow is enabled.

boolean isCubeEnabled()

Returns true if DataSet is enabled.

boolean isDataSetEnabled()

Returns true if DataSet is enabled.

boolean isHeadlessEnabled()

Returns true if headless access to Console/Navigator is permitted.

boolean isPalBillingEnabled()

Returns true if the key permits pal billing. See Pal.getBillingEngine().

boolean isPalEmailAccountEnabled()

Returns true if pal email account functionality is permitted.

boolean isRemoteServiceEnabled()

Returns true if remote service calls (web service and ftp) is permitted.

boolean isRepositoryEnabled()

Returns true if this activation key can be used for repository Pals.

boolean isShellPalsEnabled()

Returns true if shell pals is permitted.

boolean isStoreEnabled()

Returns true if this activation key permits Store installations.

boolean isSystemEnabled()

Returns true if system workflow is enabled.

boolean isTransactionEnabled()

Returns true if transaction modules are enabled.

boolean isUserWebServiceEnabled()

Returns true if user web service workflow is enabled.

boolean isWebEmailEnabled()

Returns true if web email is permitted.

boolean isWebEnabled()

Returns true if web workflow is enabled.

boolean isWebServiceEnabled()

Returns true if transaction web service workflow is enabled.

String toString()

Returns a description of this object.

Method Detail


int getAccessPeriod()

Returns the access period in months. 0 means not used. -1 means infinite (no ending).

Returns:  int

Since: 08-06-2008

top

int getArchivePeriod()

Returns the archive period in months. 0 means not used. -1 means infinite (no ending).

Returns:  int

Since: 08-06-2008

top

Data getData()

Returns a Data object containing information on this activation key.

Returns:  Data

Since: 08-06-2008

top

int getEmailExpirePeriod()

Returns the email expiration period in weeks.

Returns:  int

Since: 05-25-2011

top

int getEmailLimit()

Returns max number of emails that workflow can send per run.

Returns:  int

Since: 09-26-2011

top

int getExecutionPeriod()

Returns the execution period in months.

Returns:  int

Since: 08-06-2008

top

double getExpandFee()

Returns the fee per MB for expanding a transaction size.

Returns:  double

Since: 01-18-2017

top

String getId()

Returns the ID of the key

Returns:  String

Since: 04-14-2011

top

int getMaxAdhocDocuments()

Returns the maximum number of adhoc documents that can be added to the transaction.

Returns:  int

Since: 03-16-2010

This method has been deprecated since 10-27-2016. No replacement

top

int getMaxAudioLength()

Returns the maximum audio recording length in minutes.

Returns:  int

Since: 08-06-2008

top

int getMaxConsolePacketSize()

Returns the ConsolePacket size in kilobytes.

Returns:  int

Since: 01-29-2010

top

int getMaxDocumentSize()

Returns the maximum size an empty Document can be (in kilobytes).

Returns:  int

Since: 08-06-2008

top

int getMaxExportSize()

Returns the maximum export size (in kilobytes).

Returns:  int

Since: 03-25-2009

top

int getMaxFileSize()

Returns the maximum size of any Pal file (in kilobytes).

Returns:  int

Since: 08-06-2008

top

int getMaxHtmlDocuments()

Returns the maximum number of html documents that can be added to the transaction.

Returns:  int

Since: 08-06-2008

top

int getMaxPageSize()

Returns max page size of a dataset query.

Returns:  int

Since: 05-30-2013

top

int getMaxPalSize()

Returns the maximum size of the Pal (in kilobytes).

Returns:  int

Since: 08-06-2008

top

int getMaxPdfDocuments()

Returns the maximum number of pdf documents that can be added to the transaction.

Returns:  int

Since: 08-06-2008

top

int getMaxPdfPageCount()

Returns the max page count for PDFs.

Returns:  int

Since: 10-24-2016

top

int getMaxRoles()

Returns the maximum number of different roles allowed in the transaction.

Returns:  int

Since: 08-06-2008

top

int getMaxSignatures()

Returns the maximum number of signatures that can exist in the transaction.

Returns:  int

Since: 08-06-2008

top

int getMaxTransactionSize()

Returns the maximum transaction size in kilobytes.

Returns:  int

Since: 08-06-2008

top

int getMaxUploadSize()

Returns the max allowed upload size in kilobytes.

Returns:  int

Since: 12-13-2010

top

int getMaxUserPacketSize()

Returns the ProfilePacket size in kilobytes.

Returns:  int

Since: 01-29-2010

top

int getMaxWizards()

Returns the maximum number of wizards that can be added to the transaction.

Returns:  int

Since: 08-06-2008

top

String getName()

Returns the name of the this Activation.

Returns:  String

Since: 08-06-2008

top

String getStatus()

Returns the status of the key.

Returns:  String

Since: 03-10-2010

top

int getTimeout()

Returns the max allowed workflow timeout in seconds. See Monitor.setTimeout

Returns:  int

Since: 01-05-2010

top

int getTxJobExpirePeriod()

Returns the transaction job expiration period in weeks.

Returns:  int

Since: 05-25-2011

top

boolean isAudioEnabled()

Returns true if audio recording is enabled.

Returns:  boolean

Since: 08-06-2008

top

boolean isAuthEnabled()

Returns true if this activation key permits authentication (login) processes.

Returns:  boolean

Since: 05-14-2009

top

boolean isConsoleEnabled()

Returns true if Console workflow is enabled.

Returns:  boolean

Since: 08-06-2008

top

boolean isConsoleSystemEnabled()

Returns true if the ability to run Console System workflow is enabled.

Returns:  boolean

Since: 03-19-2009

top

boolean isConsoleWebServiceEnabled()

Returns true if the ability to run Console Web Service workflow is enabled.

Returns:  boolean

Since: 08-03-2009

top

boolean isCubeEnabled()

Returns true if DataSet is enabled.

Returns:  boolean

Since: 07-25-2019

top

boolean isDataSetEnabled()

Returns true if DataSet is enabled.

Returns:  boolean

Since: 08-06-2008

top

boolean isHeadlessEnabled()

Returns true if headless access to Console/Navigator is permitted.

Returns:  boolean

Since: 05-25-2011

top

boolean isPalBillingEnabled()

Returns true if the key permits pal billing. See Pal.getBillingEngine().

Returns:  boolean

Since: 05-30-2013

top

boolean isPalEmailAccountEnabled()

Returns true if pal email account functionality is permitted.

Returns:  boolean

Since: 04-29-2011

top

boolean isRemoteServiceEnabled()

Returns true if remote service calls (web service and ftp) is permitted.

Returns:  boolean

Since: 05-25-2011

top

boolean isRepositoryEnabled()

Returns true if this activation key can be used for repository Pals.

Returns:  boolean

Since: 08-06-2008

top

boolean isShellPalsEnabled()

Returns true if shell pals is permitted.

Returns:  boolean

Since: 05-25-2011

top

boolean isStoreEnabled()

Returns true if this activation key permits Store installations.

Returns:  boolean

Since: 09-08-2009

top

boolean isSystemEnabled()

Returns true if system workflow is enabled.

Returns:  boolean

Since: 08-06-2008

top

boolean isTransactionEnabled()

Returns true if transaction modules are enabled.

Returns:  boolean

Since: 03-29-2010

top

boolean isUserWebServiceEnabled()

Returns true if user web service workflow is enabled.

Returns:  boolean

Since: 08-10-2009

top

boolean isWebEmailEnabled()

Returns true if web email is permitted.

Returns:  boolean

Since: 05-25-2011

top

boolean isWebEnabled()

Returns true if web workflow is enabled.

Returns:  boolean

Since: 08-06-2008

top

boolean isWebServiceEnabled()

Returns true if transaction web service workflow is enabled.

Returns:  boolean

Since: 08-06-2008

top

String toString()

Returns a description of this object.

Returns:  String

Since: 08-06-2008

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM