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

All Superinterfaces:

java.io.Serializable

public interface FormServiceInvokeResponse
extends java.io.Serializable

A FormServiceInvokeResponse object is returned when calling a render or submit service for a form.

Nested Class Summary

static class	FormServiceInvokeResponse.ReaderSubmitSettings Class that determines form submission properties, such as submission format and enablement of Acrobat Reader 9.1 submission.
static class	FormServiceInvokeResponse.ReaderSubmitType

Field Summary

static java.lang.String	CALLING_APPLICATION_EMAIL
static java.lang.String	CALLING_APPLICATION_KEY
static java.lang.String	CALLING_APPLICATION_MOBILE
static java.lang.String	CALLING_APPLICATION_WORKSPACE
static java.lang.String	SWF_FILL_DATA_KEY Key name for data resulting for a Fill execution done for a .swf asset type.
static java.lang.String	TEMPLATE_PATH_ATTRIBUTE

Method Summary

java.lang.String	getClassOfTask() Get the class of task associated with this instance
FormServiceInvokeResponse.ReaderSubmitSettings	getReaderSubmitSettings() Returns ReaderSubmit options for the rendered form.
Document	getResultingDocument() Retrieves the Document resulting as output from the render or submit call.
java.util.Map	getResultingMap() Retrieves the map of arbitrary values resulting from the render or submit call.
TaskUIOptions	getTaskUIOptions() Get the TaskUIOptions object associated with this instance
java.lang.String	getTRCVariableName() Returns the name of the TaskResultCollection variable that is associated with this task This is only returned when calling Render, not when calling submit.
java.util.List	getUserActions() Returns the list of user actions what were designed at run time.
boolean	isDocumentForm() Returns a hint that the content of the associated Form is being stored as a Document, and might likely have PDF Signatures on it.
void	setClassOfTask(java.lang.String classOfTask) Set the class of task
void	setTaskUIOptions(TaskUIOptions taskUIOptions) Set the TaskUIOptions object

Field Detail

TEMPLATE_PATH_ATTRIBUTE

static final java.lang.String TEMPLATE_PATH_ATTRIBUTE

See Also:

Constant Field Values

SWF_FILL_DATA_KEY

static final java.lang.String SWF_FILL_DATA_KEY

Key name for data resulting for a Fill execution done for a .swf asset type.

See Also:

Constant Field Values

CALLING_APPLICATION_KEY

static final java.lang.String CALLING_APPLICATION_KEY

See Also:

Constant Field Values

CALLING_APPLICATION_MOBILE

static final java.lang.String CALLING_APPLICATION_MOBILE

See Also:

Constant Field Values

CALLING_APPLICATION_EMAIL

static final java.lang.String CALLING_APPLICATION_EMAIL

See Also:

Constant Field Values

CALLING_APPLICATION_WORKSPACE

static final java.lang.String CALLING_APPLICATION_WORKSPACE

See Also:

Constant Field Values

Method Detail

getResultingDocument

Document getResultingDocument()

Retrieves the Document resulting as output from the render or submit call.

Returns:

The Document resulting as output from the render or submit call.

getResultingMap

java.util.Map getResultingMap()

Retrieves the map of arbitrary values resulting from the render or submit call.

Returns:

The map of arbitrary values resulting from the render or submit call.

getUserActions

java.util.List getUserActions()

Returns the list of user actions what were designed at run time. The object includes the name, route, and confirmation message information for each action

Returns:

The list of design time defined user actions

isDocumentForm

boolean isDocumentForm()

Returns a hint that the content of the associated Form is being stored as a Document, and might likely have PDF Signatures on it. When this returns true, calling applications should not change the document, and should pass it directly to the end user instead.

Returns:

true if the form is being stored as a document.

getTRCVariableName

java.lang.String getTRCVariableName()

Returns the name of the TaskResultCollection variable that is associated with this task This is only returned when calling Render, not when calling submit.

Returns:

Name of Variable if one is specified, otherwise return null

getReaderSubmitSettings

FormServiceInvokeResponse.ReaderSubmitSettings getReaderSubmitSettings()

Returns ReaderSubmit options for the rendered form. Returns null if there are no reader submit options set.

Returns:

Reader submit options for the rendered form.

setTaskUIOptions

void setTaskUIOptions(TaskUIOptions taskUIOptions)

Set the TaskUIOptions object

Parameters:

taskUIOptions - The task ui options to set

getTaskUIOptions

TaskUIOptions getTaskUIOptions()

Get the TaskUIOptions object associated with this instance

setClassOfTask

void setClassOfTask(java.lang.String classOfTask)

Set the class of task

Parameters:

classOfTask - The class of task to set

getClassOfTask

java.lang.String getClassOfTask()

Get the class of task associated with this instance