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

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

FormInstance

public interface FormInstanceBase
extends java.io.Serializable

The base interface for storage of form data.

This is the base interface for the form data used in Workflow and the FormInstance object used by many of the TaskManager methods.

The implementing classes use this interface to implement a value object.

Method Summary

java.lang.String[]	getActionList() Retrieves a list of actions from which to choose.
java.lang.String	getHardenedTemplatePath() Deprecated. Hardened Paths are no longer supported. Paths are hardened based on timestamps.
java.lang.String	getSelectedAction() Retrieves the action selected from the value object.
java.lang.String	getTemplatePath() Retrieves the template path from the value object.
byte[]	getXFAData() Retrieves XFA data from the value object.
void	setActionList(java.lang.String[] actions) Sets a list of actions in the value object.
void	setHardenedTemplatePath(java.lang.String appstoreHardenedPath) Deprecated. Hardened Paths are no longer supported. Paths are hardened based on timestamps.
void	setSelectedAction(java.lang.String aSelectedAction) Sets a selected action.
void	setTemplatePath(java.lang.String appstoreTemplatePath) Sets the path to the form template identified by this form instance object.
void	setXFAData(byte[] xfaData) Sets XFA data in the value object.

Method Detail

setXFAData

void setXFAData(byte[] xfaData)

Sets XFA data in the value object.

Parameters:

xfaData - Properly formatted XDP XML data.

getXFAData

byte[] getXFAData()

Retrieves XFA data from the value object.

Returns:

The XDP data for the task.

setHardenedTemplatePath

void setHardenedTemplatePath(java.lang.String appstoreHardenedPath)

Deprecated. Hardened Paths are no longer supported. Paths are hardened based on timestamps.

Sets a hardened path (a path that contains specific version information) to the form template.

This is optional if you already have a hardened path to the form.

Parameters:

appstoreHardenedPath - The hardened path to the form template.

getHardenedTemplatePath

java.lang.String getHardenedTemplatePath()

Deprecated. Hardened Paths are no longer supported. Paths are hardened based on timestamps.

Retrieves the hardened path from the value object.

Returns:

The hardened path from the value object.

setTemplatePath

void setTemplatePath(java.lang.String appstoreTemplatePath)

Sets the path to the form template identified by this form instance object.

Parameters:

appstoreTemplatePath - The path to the form template.

getTemplatePath

java.lang.String getTemplatePath()

Retrieves the template path from the value object.

Returns:

The template path.

getSelectedAction

java.lang.String getSelectedAction()

Retrieves the action selected from the value object.

Returns:

The selected action. For TaskManager, the selected action indicates a route leaving a User component.

setSelectedAction

void setSelectedAction(java.lang.String aSelectedAction)

Sets a selected action.

Parameters:

aSelectedAction - The selected action (the route leaving the User component).

getActionList

java.lang.String[] getActionList()

Retrieves a list of actions from which to choose. TaskManager returns a list of routes leaving a User step.

Returns:

The list of actions.

setActionList

void setActionList(java.lang.String[] actions)

Sets a list of actions in the value object.

Parameters:

actions - The list of actions.