ConsolePacket

Method Summary
	commit() Typically changes to the packet are committed at the end of the workflow cycle. However, sometimes you need to commit before, in which case use this method.
PacketDataList	createDataList(String name, String[] columns) Creates a new persistent DataList and returns it. Maximum column size is 20. Quietly over-rides any existing DataList with the same name. Column names cannot be null or empty.
	deleteData(String name) Deletes the Data object with the given name.
	deleteDataList(String name) Deletes the specified DataList.
	deleteProperty(String name) Deletes the specified property.
boolean	disableSystemWorkflow() Disables/cancels execution of console system workflow. If there is no console system workflowassociated with this Pal, calling this method is quietly ignored. This method returns false if console system workflow is not enabled.
boolean	enableSystemWorkflow() Marks the system workflow (if any) available for immediate execution. If there is no console system workflowassociated with this Pal, calling this method is quietly ignored. This method returns false if console system workflow is not enabled.
Data	getData(String name) Returns the named Data object. Modifications to the content of the Data object are automatically persisted.
PacketDataList	getDataList(String name) Returns the specified DataList if it exists, or null if it does not.
String	getDefaultProperty(String field, String defaultValue, boolean emptyIsNull) Returns the given property. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.
SystemDataView	getEmailJobs() Returns list of email jobs for this enterprise created by the controlling Pal.
Date	getLastCycle() Returns the date when Console System workflow will ran last.
Date	getNextCycle() Returns the date when Console System workflow will run next.
Enterprise	getOwnerEnterprise() ⚠Deprecated since 02-17-2011. Use Controller.getEnterprise(). Returns the enterprise that owns the Pal/ConsolePacket.
String	getPalId() Returns the ID of this Pal.
Data	getProperties() Returns all properties of this Packet. Changes made to these items are automatically persisted.
String	getProperty(String name) Returns the specified property.
int	getSize() Returns the size of this ConsolePacket in bytes.
String	getStatus() Returns the status of the packet.
String	getSystemErrorMessage() Returns the error message, if any, of Console System workflow.
String	getSystemStatus() Returns the system status
boolean	isStatus(String status) Returns true if the packet status is the specified status.
boolean	isSystemError() Returns true if Console System workflow generated an error.
boolean	schedule(Date date) Schedules the console system workflow to run on the given date. Returns false if the given date is already passed. Daemons run on a schedule, so execution time may not be exact.
	setData(String name, Data data) Saves the Data object with the given name, over-writing any existing Data object with the same name.
	setDataList(PacketDataList list) Saves the specified DataList, over-writing any other table that might exist with the same name.
	setProperty(String name, String value) Sets the specified property.
	setStatus(String status) Sets the status of the packet.
	setSystemStatus(String status) Sets the system status
String	toString() Returns a description of this object

Method Detail

commit()

Typically changes to the packet are committed at the end of the workflow cycle. However, sometimes you need to commit before, in which case use this method.

Since: 08-23-2013

top

PacketDataList createDataList(String name, String[] columns)

Creates a new persistent DataList and returns it. Maximum column size is 20. Quietly over-rides any existing DataList with the same name. Column names cannot be null or empty.

Parameters:

String name
String[] columns

Returns: PacketDataList

Since: 03-19-2009

top

deleteData(String name)

Deletes the Data object with the given name.

Parameters:

String name

Since: 03-19-2009

top

deleteDataList(String name)

Deletes the specified DataList.

Parameters:

String name

Since: 03-19-2009

top

deleteProperty(String name)

Deletes the specified property.

Parameters:

String name

Since: 03-19-2009

top

boolean disableSystemWorkflow()

Disables/cancels execution of console system workflow. If there is no console system workflowassociated with this Pal, calling this method is quietly ignored. This method returns false if console system workflow is not enabled.

Returns: boolean

Since: 03-19-2009

top

boolean enableSystemWorkflow()

Marks the system workflow (if any) available for immediate execution. If there is no console system workflowassociated with this Pal, calling this method is quietly ignored. This method returns false if console system workflow is not enabled.

Returns: boolean

Since: 03-19-2009

top

Data getData(String name)

Returns the named Data object. Modifications to the content of the Data object are automatically persisted.

Parameters:

String name

Returns: Data

Since: 03-19-2009

top

PacketDataList getDataList(String name)

Returns the specified DataList if it exists, or null if it does not.

Parameters:

String name

Returns: PacketDataList

Since: 03-19-2009

top

String getDefaultProperty(String field, String defaultValue, boolean emptyIsNull)

Returns the given property. If the field does not exist, it returns the default value. If the field exists but is value is empty, this method returns defaultValue only if emptyIsNull=true.

Parameters:

String field
String defaultValue
boolean emptyIsNull

Returns: String

Since: 03-19-2009

top

SystemDataView getEmailJobs()

Returns list of email jobs for this enterprise created by the controlling Pal.

Returns: SystemDataView

DataList Name: ConsoleEmailJobs
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
email	String
subject	String
status	String
created	Date
sent	Date
expireDate	Date
attempts	Number
nextAttempt	Date
replyTo	String
type	String
sendDate	Date
deliveryStatus	String
senderFirstName	String
senderLastName	String
settingsId	String
senderEmail	String

Since: 09-08-2010

top

Date getLastCycle()

Returns the date when Console System workflow will ran last.

Returns: Date

Since: 03-19-2009

top

Date getNextCycle()

Returns the date when Console System workflow will run next.

Returns: Date

Since: 03-19-2009

top

Enterprise getOwnerEnterprise()

Returns the enterprise that owns the Pal/ConsolePacket.

Returns: Enterprise

Since: 06-07-2009

This method has been deprecated since 02-17-2011. Use Controller.getEnterprise().

top

String getPalId()

Returns the ID of this Pal.

Returns: String

Since: 09-02-2009

top

Data getProperties()

Returns all properties of this Packet. Changes made to these items are automatically persisted.

Returns: Data

Since: 03-19-2009

top

String getProperty(String name)

Returns the specified property.

Parameters:

String name

Returns: String

Since: 03-19-2009

top

int getSize()

Returns the size of this ConsolePacket in bytes.

Returns: int

Since: 01-29-2010

top

String getStatus()

Returns the status of the packet.

Returns: String

Since: 03-19-2009

top

String getSystemErrorMessage()

Returns the error message, if any, of Console System workflow.

Returns: String

Since: 03-19-2009

top

String getSystemStatus()

Returns the system status

Returns: String

Since: 03-19-2009

top

boolean isStatus(String status)

Returns true if the packet status is the specified status.

Parameters:

String status

Returns: boolean

Since: 03-19-2009

top

boolean isSystemError()

Returns true if Console System workflow generated an error.

Returns: boolean

Since: 03-19-2009

top

boolean schedule(Date date)

Schedules the console system workflow to run on the given date. Returns false if the given date is already passed. Daemons run on a schedule, so execution time may not be exact.

Parameters: