|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FormInstance
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 |
---|
static final short FORM_DATA_TYPE
The data in this type can be accessed by a workflow because the form definition template is separate from the form data.
static final short DOCUMENT_DATA_TYPE
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.
static final java.lang.String DOCUMENT_PERSIST_PREFIX
Method Detail |
---|
short getDataTypeIn()
FormInstance.FORM_DATA_TYPE
or FormInstance.DOCUMENT_DATA_TYPE
.short getDataTypeOut()
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.
FormInstance.DOCUMENT_DATA_TYPE
.short getCurrentDataType()
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.
FormInstance.DOCUMENT_DATA_TYPE
.Document getDocument()
Document
for this FormInstance
object.
It is only valid if the current data type is Document
(FormInstance.DOCUMENT_DATA_TYPE
).
com.adobe.idp.Document
object that contains the data for this task.void setDocument(Document aDocument)
com.adobe.idp.Document
object as the data to be saved for this task.
aDocument
- The Document
to set.long getFormInstanceId()
FormInstance
identifier for this task.
This method is useful for Document
handling.
FormInstance
identifier for this task.void setFormInstanceId(long aFormInstanceId)
FormInstance
identifier for this task.
aFormInstanceId
- The FormInstance
identifier for this task.short getAssignedQueueType()
QueueManager.QUEUE_TYPE_USER
)
or a group queue (QueueManager.QUEUE_TYPE_GROUP
).UserQueue
,
GroupQueue
,
QueueManager
java.lang.String getAssignedPrincipalId()
short getTaskStatus()
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.
boolean isDataEmpty()
FormInstance
object is empty.
true
if the data is empty, false
otherwise.boolean isItemUpdated()
true
if the data has been updated, false
otherwise.boolean isItemUpdateRequired()
true
if the data must be updated, false
otherwise.void setUseTaskRoutes(boolean useTaskRoutes)
useTaskRoutes
- true
if the task routes are to be copied to the task item, false
otherwise.boolean isUseTaskRoutes()
true
if the form should use the task routes for its actions, false
otherwise.void setActionRequired(boolean aRequired)
aRequired
- true
when the action is required, false
otherwise.boolean isActionRequired()
true
when an action is required, false
otherwise.boolean isDocumentForm()
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:
true
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |