Console API

PalInfo

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
boolean checkTransactionAccess(String profileId)

Returns true if the Pal is accessible by the identified profile.

String getCategory()

Returns the category of the Pal.

String getChainId()

Returns the pal's chain id, if is using a PalChain.

String getConsoleLoginUrl()

Returns the console login url for this Pal.

Data getData()

Returns Data with top level information about this Pal.

String getDescription()

Returns the description of the Pal.

String getId()

Returns the pal id.

String getName()

Returns the name of the Pal.

String getSecureWebUrl(String endPoint)

Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.

String getStoreId()

If the Pal is published in the store, returns the storeId.

String getVersion()

Returns the version of the Pal.

String getWebUrl()

Returns the public URL for this Pal.

boolean hasLogo()

Returns true if the Pal has a logo associated with it.

boolean isConsoleModule()

Returns true if this Pal has a console module.

boolean isLinked()

Returns true if the Pal is a linked Pal.

boolean isShadow()

Returns true if the Pal is a shadow Pal.

boolean isShell()

Returns true if the Pal is a Shell Pal.

boolean isTestMode()

Returns true if the Pal is being executed in test mode.

boolean isTransactionModule()

Returns true if this Pal has a transaction module.

boolean isWebModule()

Returns true if this Pal has a web module.

String toString()

Returns a description of this object.

Method Detail


boolean checkTransactionAccess(String profileId)

Returns true if the Pal is accessible by the identified profile.

Parameters:

  • String   profileId Required parameter.

Returns:  boolean

Since: 09-25-2009

top

String getCategory()

Returns the category of the Pal.

Returns:  String

Since: 09-25-2009

top

String getChainId()

Returns the pal's chain id, if is using a PalChain.

Returns:  String

Since: 04-14-2011

top

String getConsoleLoginUrl()

Returns the console login url for this Pal.

Returns:  String

Since: 10-07-2010

top

Data getData()

Returns Data with top level information about this Pal.

Returns:  Data

Since: 05-13-2015

top

String getDescription()

Returns the description of the Pal.

Returns:  String

Since: 09-25-2009

top

String getId()

Returns the pal id.

Returns:  String

Since: 05-22-2010

top

String getName()

Returns the name of the Pal.

Returns:  String

Since: 09-25-2009

top

String getSecureWebUrl(String endPoint)

Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.

Parameters:

  • String   endPoint

Returns:  String

Since: 11-16-2015

top

String getStoreId()

If the Pal is published in the store, returns the storeId.

Returns:  String

Since: 09-25-2009

top

String getVersion()

Returns the version of the Pal.

Returns:  String

Since: 10-27-2009

top

String getWebUrl()

Returns the public URL for this Pal.

Returns:  String

Since: 01-26-2010

top

boolean hasLogo()

Returns true if the Pal has a logo associated with it.

Returns:  boolean

Since: 10-27-2009

top

boolean isConsoleModule()

Returns true if this Pal has a console module.

Returns:  boolean

Since: 05-20-2010

top

boolean isLinked()

Returns true if the Pal is a linked Pal.

Returns:  boolean

Since: 10-27-2009

top

boolean isShadow()

Returns true if the Pal is a shadow Pal.

Returns:  boolean

Since: 10-27-2009

top

boolean isShell()

Returns true if the Pal is a Shell Pal.

Returns:  boolean

Since: 07-13-2011

top

boolean isTestMode()

Returns true if the Pal is being executed in test mode.

Returns:  boolean

Since: 10-27-2009

top

boolean isTransactionModule()

Returns true if this Pal has a transaction module.

Returns:  boolean

Since: 05-20-2010

top

boolean isWebModule()

Returns true if this Pal has a web module.

Returns:  boolean

Since: 05-20-2010

top

String toString()

Returns a description of this object.

Returns:  String

Since: 09-25-2009

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