Console API

Job

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
  commit()

Saves payload back to the storage layer for this job.

String getId()

Returns the job id. Max length is 30.

String getName()

Returns the job name.

Payload getPayload()

Returns the payload for the job. This method always returns a non null payload, even if the payload itself has no data.

int getRunCount()

Returns the number of times this job has run.

Date getRunDate()

Returns the date the job ran or null if it has not yet ran.

Date getScheduleDate()

Returns the date the job is scheduled to run.

String getStatus()

Returns the job status. Status will be New, Finished, Queued, Running, Rescheduled, Error, Deleted, or Unknown

  remove()

Removes this job from the job queue (deletes it) effective at the end of the workflow cycle.

  reschedule(Date date)

Reschedules this job to run again at the date and time specified. The time must be in the future. Great care should be taken in using this method since usually you run a job once and forget about it.

  setPayload(Payload payload)

Sets the job's payload. For this to persist, call commit(). Max serialized payload is approx 16MB.

String toString()

Returns a description of this object.

Method Detail


commit()

Saves payload back to the storage layer for this job.

Since: 11-03-2016

top

String getId()

Returns the job id. Max length is 30.

Returns:  String

Since: 12-21-2012

top

String getName()

Returns the job name.

Returns:  String

Since: 12-21-2012

top

Payload getPayload()

Returns the payload for the job. This method always returns a non null payload, even if the payload itself has no data.

Returns:  Payload

Since: 12-21-2012

top

int getRunCount()

Returns the number of times this job has run.

Returns:  int

Since: 11-03-2016

top

Date getRunDate()

Returns the date the job ran or null if it has not yet ran.

Returns:  Date

Since: 01-07-2013

top

Date getScheduleDate()

Returns the date the job is scheduled to run.

Returns:  Date

Since: 01-07-2013

top

String getStatus()

Returns the job status. Status will be New, Finished, Queued, Running, Rescheduled, Error, Deleted, or Unknown

Returns:  String

Since: 01-07-2013

top

remove()

Removes this job from the job queue (deletes it) effective at the end of the workflow cycle.

Since: 01-07-2013

top

reschedule(Date date)

Reschedules this job to run again at the date and time specified. The time must be in the future. Great care should be taken in using this method since usually you run a job once and forget about it.

Parameters:

  • Date   date Required parameter.

Since: 11-03-2016

top

setPayload(Payload payload)

Sets the job's payload. For this to persist, call commit(). Max serialized payload is approx 16MB.

Parameters:

Since: 11-03-2016

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-21-2012

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