| Package | com.adobe.idp.taskmanager.dsc.client.task |
| Interface | public interface FormInstance |
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.
| Method | Defined By | ||
|---|---|---|---|
String getAssignedPrincipalId() Retrieves the principal identifier for the owner of this task. | FormInstance | ||
short getAssignedQueueType() Retrieves the currently assigned queue's type. | FormInstance | ||
short getCurrentDataType() Retrieves the type of data this task currently contains. | FormInstance | ||
short getDataTypeIn() Retrieves the type of data this task holds when the task was created. | FormInstance | ||
short getDataTypeOut() Retrieves the type of data this task will submit to the server after it is completed or saved. | FormInstance | ||
Retrieves the Document for this FormInstance object. | FormInstance | ||
long getFormInstanceId() Retrieves the FormInstance identifier for this task. | FormInstance | ||
short getTaskStatus() Retrieves the current status of the task. | FormInstance | ||
boolean isActionRequired() Determines whether an action must be chosen for this form. | FormInstance | ||
boolean isDataEmpty() Indicates if the data contained in this FormInstance object is empty. | FormInstance | ||
boolean isDocumentForm() Returns true if this Form is actually stored in document format on the server. | FormInstance | ||
boolean isItemUpdated() Indicates if this form item data has been updated. | FormInstance | ||
boolean isItemUpdateRequired() Indicates if this form requires an update before the task can be completed. | FormInstance | ||
boolean isUseTaskRoutes() Determines if this task item should populate its action list from the task routes. | FormInstance | ||
void setActionRequired(boolean aRequired) Sets whether whether an action must be chosen for this task. | FormInstance | ||
void setDocument(Document aDocument) Sets a valid unread com.adobe.idp.Document object as the data to be saved for this task. | FormInstance | ||
void setFormInstanceId(long aFormInstanceId) Optional. | FormInstance | ||
void setUseTaskRoutes(boolean useTaskRoutes) Sets whether this task item should populate its action list from the task routes. | FormInstance | ||
| Constant | Defined By | ||
|---|---|---|---|
| DOCUMENT_DATA_TYPE [static] The com.adobe.idp.Document storage type for tasks. | FormInstance | ||
| DOCUMENT_PERSIST_PREFIX [static] Prefix used for persisted documents. | FormInstance | ||
| FORM_DATA_TYPE [static] Form data storage type for tasks. | FormInstance | ||
| getAssignedPrincipalId | () |
public String getAssignedPrincipalId()Retrieves the principal identifier for the owner of this task.
Returns| The principal identifier for the owner of this task. |
| getAssignedQueueType | () |
public 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 (com.adobe.idp.taskmanager.dsc.client.queuemanager.QueueManager#QUEUE_TYPE_USER) or a group queue (com.adobe.idp.taskmanager.dsc.client.queuemanager.QueueManager#QUEUE_TYPE_GROUP). |
See also
| getCurrentDataType | () |
public short getCurrentDataType()Retrieves the type of data this task currently contains.
Returns| The data type the task currently has stored, which is either FORM_DATA_TYPE or DOCUMENT_DATA_TYPE. |
| getDataTypeIn | () |
public short getDataTypeIn()Retrieves the type of data this task holds when the task was created.
Returns| Either FORM_DATA_TYPE or DOCUMENT_DATA_TYPE. |
| getDataTypeOut | () |
public short getDataTypeOut()Retrieves the type of data this task will submit to the server after it is completed or saved.
Returns| The data type the task will store, which will be either FORM_DATA_TYPE or DOCUMENT_DATA_TYPE. |
| getDocument | () |
public Document getDocument()Retrieves the Document for this FormInstance object. It is only valid if the current data type is Document (DOCUMENT_DATA_TYPE).
A com.adobe.idp.Document object that contains the data for this task. |
| getFormInstanceId | () |
public long getFormInstanceId()Retrieves the FormInstance identifier for this task.
This method is useful for Document handling.
The FormInstance identifier for this task. |
| getTaskStatus | () |
public 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.
| The task status. |
| isActionRequired | () |
public boolean isActionRequired()Determines whether an action must be chosen for this form.
Returnstrue when an action is required, false otherwise. |
| isDataEmpty | () |
public boolean isDataEmpty()Indicates if the data contained in this FormInstance object is empty.
true if the data is empty, false otherwise. |
| isDocumentForm | () |
public boolean isDocumentForm()Returns true if this Form is actually stored in document format on the server.
This method was added in LiveCycle ES 8.2.
Returns| The value true if the form/data is stored as a document. |
| isItemUpdated | () |
public boolean isItemUpdated()Indicates if this form item data has been updated.
Returnstrue if the data has been updated, false otherwise. |
| isItemUpdateRequired | () |
public boolean isItemUpdateRequired()Indicates if this form requires an update before the task can be completed.
Returnstrue if the data must be updated, false otherwise. |
| isUseTaskRoutes | () |
public boolean isUseTaskRoutes()Determines if this task item should populate its action list from the task routes.
Returnstrue if the form should use the task routes for its actions, false otherwise. |
| setActionRequired | () |
public 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. |
| setDocument | () |
public 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. |
| setFormInstanceId | () |
public void setFormInstanceId(long aFormInstanceId)Optional. Sets the FormInstance identifier for this task.
Parameters
aFormInstanceId — The FormInstance identifier for this task. |
| setUseTaskRoutes | () |
public 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. |
| DOCUMENT_DATA_TYPE | Constant |
public static final DOCUMENT_DATA_TYPEThe 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.
| DOCUMENT_PERSIST_PREFIX | Constant |
public static final DOCUMENT_PERSIST_PREFIXPrefix used for persisted documents.
| FORM_DATA_TYPE | Constant |
public static final FORM_DATA_TYPEForm 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.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/taskmanager/dsc/client/task/FormInstance.html