com.adobe.idp.taskmanager.dsc.client.task
Interface FormInstance

All Superinterfaces:

FormInstanceBase, java.io.Serializable

public interface FormInstance
extends FormInstanceBase, java.io.Serializable

Represents the metadata for a form.

You get an instance of a FormInstance object by calling the TaskManager.getEmptyForm() method and using the various methods to define its properties.

You can get a form that is already associated with a task by calling the TaskManager.getFormInstanceForTask(long, long) or TaskManager.getFormInstanceForTask(long, long, boolean) method.

Field Summary

static short	DOCUMENT_DATA_TYPE The com.adobe.idp.Document storage type for tasks.
static java.lang.String	DOCUMENT_PERSIST_PREFIX Prefix used for persisted documents.
static short	FORM_DATA_TYPE Form data storage type for tasks.

Method Summary

java.lang.String	getAssignedPrincipalId() Retrieves the principal identifier for the owner of this task.
short	getAssignedQueueType() Retrieves the currently assigned queue's type.
short	getCurrentDataType() (Obsolete) Retrieves the type of data this task currently contains.
short	getDataTypeIn() Retrieves the type of data this task holds when the task was created.
short	getDataTypeOut() (Obsolete) Retrieves the type of data this task will submit to the server after it is completed or saved.
Document	getDocument() Retrieves the Document for this FormInstance object.
long	getFormInstanceId() Retrieves the FormInstance identifier for this task.
short	getTaskStatus() Retrieves the current status of the task.
boolean	isActionRequired() Determines whether an action must be chosen for this form.
boolean	isDataEmpty() Indicates if the data contained in this FormInstance object is empty.
boolean	isDocumentForm() (Obsolete) Returns true if the Form is stored on the server as a com.adobe.idp.Document object.
boolean	isItemUpdated() Indicates if this form item data has been updated.
boolean	isItemUpdateRequired() Indicates if this form requires an update before the task can be completed.
boolean	isUseTaskRoutes() Determines if this task item should populate its action list from the task routes.
void	setActionRequired(boolean aRequired) Sets whether whether an action must be chosen for this task.
void	setDocument(Document aDocument) Sets a valid unread com.adobe.idp.Document object as the data to be saved for this task.
void	setFormInstanceId(long aFormInstanceId) Optional.
void	setUseTaskRoutes(boolean useTaskRoutes) Sets whether this task item should populate its action list from the task routes.

Methods inherited from interface com.adobe.idp.taskmanager.dsc.client.task.FormInstanceBase

getActionList, getHardenedTemplatePath, getSelectedAction, getTemplatePath, getXFAData, setActionList, setHardenedTemplatePath, setSelectedAction, setTemplatePath, setXFAData

Field Detail

FORM_DATA_TYPE

static final short FORM_DATA_TYPE

Form data storage type for tasks.

The data in this type can be accessed by a workflow because the form definition template is separate from the form data.

See Also:

Constant Field Values

DOCUMENT_DATA_TYPE

static final short DOCUMENT_DATA_TYPE

The com.adobe.idp.Document storage type for tasks.

Such documents are static PDF documents. The data in them cannot be accessed by a workflow without calling an operation to retrieve the XDP data.

See Also:

Constant Field Values

DOCUMENT_PERSIST_PREFIX

static final java.lang.String DOCUMENT_PERSIST_PREFIX

Prefix used for persisted documents.

See Also:

Constant Field Values

Method Detail

getDataTypeIn

short getDataTypeIn()

Retrieves the type of data this task holds when the task was created.

Returns:

Either FormInstance.FORM_DATA_TYPE or FormInstance.DOCUMENT_DATA_TYPE.

getDataTypeOut

short getDataTypeOut()

(Obsolete) Retrieves the type of data this task will submit to the server after it is completed or saved.

Beginning with LiveCycle 9.0, LiveCycle 9.0 uses the XML and Document datatypes in place of the proprietary xfaForm and DocumentForm datatypes. This method returns FormInstance.DOCUMENT_DATA_TYPE regardless of datatype.

Returns:

The data type the task will store, which will always be FormInstance.DOCUMENT_DATA_TYPE.

getCurrentDataType

short getCurrentDataType()

(Obsolete) Retrieves the type of data this task currently contains.

Beginning with LiveCycle 9.0, LiveCycle 9.0 uses the XML and Document datatypes in place of the proprietary xfaForm and DocumentForm datatypes. This method returns FormInstance.DOCUMENT_DATA_TYPE regardless of datatype.

Returns:

The data type the task currently has stored, which is always FormInstance.DOCUMENT_DATA_TYPE.

getDocument

Document getDocument()

Retrieves the Document for this FormInstance object. It is only valid if the current data type is Document (FormInstance.DOCUMENT_DATA_TYPE).

Returns:

A com.adobe.idp.Document object that contains the data for this task.

setDocument

void setDocument(Document aDocument)

Sets a valid unread com.adobe.idp.Document object as the data to be saved for this task.

Parameters:

aDocument - The Document to set.

getFormInstanceId

long getFormInstanceId()

Retrieves the FormInstance identifier for this task.

This method is useful for Document handling.

Returns:

The FormInstance identifier for this task.

setFormInstanceId

void setFormInstanceId(long aFormInstanceId)

Optional. Sets the FormInstance identifier for this task.

Parameters:

aFormInstanceId - The FormInstance identifier for this task.

getAssignedQueueType

short getAssignedQueueType()

Retrieves the currently assigned queue's type.

Returns:

The queue type for this task's current assignment, which will be either a user queue (QueueManager.QUEUE_TYPE_USER) or a group queue (QueueManager.QUEUE_TYPE_GROUP).

See Also:

UserQueue, GroupQueue, QueueManager

getAssignedPrincipalId

java.lang.String getAssignedPrincipalId()

Retrieves the principal identifier for the owner of this task.

Returns:

The principal identifier for the owner of this task.

getTaskStatus

short getTaskStatus()

Retrieves the current status of the task.

This method is useful when you would like to avoid performing extra queries to find this information in cases in which the FormInstance is already being returned.

Returns:

The task status.

isDataEmpty

boolean isDataEmpty()

Indicates if the data contained in this FormInstance object is empty.

Returns:

true if the data is empty, false otherwise.

isItemUpdated

boolean isItemUpdated()

Indicates if this form item data has been updated.

Returns:

true if the data has been updated, false otherwise.

isItemUpdateRequired

boolean isItemUpdateRequired()

Indicates if this form requires an update before the task can be completed.

Returns:

true if the data must be updated, false otherwise.

setUseTaskRoutes

void setUseTaskRoutes(boolean useTaskRoutes)

Sets whether this task item should populate its action list from the task routes.

Parameters:

useTaskRoutes - true if the task routes are to be copied to the task item, false otherwise.

isUseTaskRoutes

boolean isUseTaskRoutes()

Determines if this task item should populate its action list from the task routes.

Returns:

true if the form should use the task routes for its actions, false otherwise.

setActionRequired

void setActionRequired(boolean aRequired)

Sets whether whether an action must be chosen for this task.

Parameters:

aRequired - true when the action is required, false otherwise.

isActionRequired

boolean isActionRequired()

Determines whether an action must be chosen for this form.

Returns:

true when an action is required, false otherwise.

isDocumentForm

boolean isDocumentForm()

(Obsolete) Returns true if the Form is stored on the server as a com.adobe.idp.Document object.

Beginning with LiveCycle 9.0, this method always returns true. LiveCycle 9.0 uses the XML and Document datatypes in place of the proprietary xfaForm and DocumentForm datatypes.

In earlier LiveCycle versions, this method distinguished between forms and data:

• Document Form data type references the actual form as a document value
• xfaForm and Form data types reference only the data in the form

Returns:

Always returns true.