ProfilePacket

Method Summary
	clearPacket() Deletes all Data, DataLists, and properties stored in this packet.
	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.
String	getBillingReference() Returns the billing reference associated with the access fee for this Packet.
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.
Payload	getPayload() Returns copies of all Data, DataLists, and properties as a Payload object.
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 ProfilePacket in bytes.
String	getStatus() Returns the status of the packet.
boolean	isStatus(String status) Returns true if the packet status is the specified status.
	setBillingReference(String reference) Sets the billing reference associated with the access fee for this Packet.
	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.
String	toString() Returns a description of this object.

Method Detail

---

clearPacket()

Deletes all Data, DataLists, and properties stored in this packet.

Since: 01-06-2015

---

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

---

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: 12-31-2008

---

deleteData(String name)

Deletes the Data object with the given name.

Parameters:

• String   name

Since: 12-31-2008

---

deleteDataList(String name)

Deletes the specified DataList.

Parameters:

• String   name

Since: 12-31-2008

---

deleteProperty(String name)

Deletes the specified property.

Parameters:

• String   name

Since: 12-31-2008

---

String getBillingReference()

Returns the billing reference associated with the access fee for this Packet.

Returns:  String

Since: 05-05-2010

---

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: 12-31-2008

---

PacketDataList getDataList(String name)

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

Parameters:

• String   name

Returns:  PacketDataList

Since: 12-31-2008

---

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: 12-31-2008

---

Payload getPayload()

Returns copies of all Data, DataLists, and properties as a Payload object.

Returns:  Payload

Since: 01-06-2015

---

Data getProperties()

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

Returns:  Data

Since: 12-31-2008

---

String getProperty(String name)

Returns the specified property.

Parameters:

• String   name

Returns:  String

Since: 12-31-2008

---

int getSize()

Returns the size of this ProfilePacket in bytes.

Returns:  int

Since: 01-29-2010

---

String getStatus()

Returns the status of the packet.

Returns:  String

Since: 12-31-2008

---

boolean isStatus(String status)

Returns true if the packet status is the specified status.

Parameters:

• String   status

Returns:  boolean

Since: 12-31-2008

---

setBillingReference(String reference)

Sets the billing reference associated with the access fee for this Packet.

Parameters:

• String   reference Maximum allowed size of parameter: 15

Since: 05-05-2010

---

setData(String name, Data data)

Saves the Data object with the given name, over-writing any existing Data object with the same name.

Parameters:

• String   name
• Data   data

Since: 12-31-2008

---

setDataList(PacketDataList list)

Saves the specified DataList, over-writing any other table that might exist with the same name.

Parameters:

• PacketDataList   list

Since: 12-31-2008

---

setProperty(String name, String value)

Sets the specified property.

Parameters:

• String   name
• String   value

Since: 12-31-2008

---

setStatus(String status)

Sets the status of the packet.

Parameters:

• String   status Maximum allowed size of parameter: 80

Since: 12-31-2008

---

String toString()

Returns a description of this object.

Returns:  String

Since: 12-31-2008