org.yawlfoundation.yawl.resourcing

Interface DynamicForm

All Known Implementing Classes:

DynFormFactory

public interface DynamicForm

Author:

Michael Adams

Created/Last Date:

11/07/13

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataList() Gets the form's data list on completion of the form.
java.util.List<java.lang.Long>	getDocComponentIDs() Gets a list of component identifiers that represent documents managed by the doc store service.
boolean	makeForm(java.lang.String title, java.lang.String header, java.lang.String schema, java.util.List<YParameter> parameters) Build and show a form to capture the input data values on a case start.
boolean	makeForm(java.lang.String title, java.lang.String header, java.lang.String schema, WorkItemRecord wir) Build and show a form to capture the work item's output data values.

Method Detail

makeForm

boolean makeForm(java.lang.String title,
                 java.lang.String header,
                 java.lang.String schema,
                 WorkItemRecord wir)

Build and show a form to capture the work item's output data values.

Parameters:

title - The form's title

header - A header text for the form top

schema - An XSD schema of the data types and attributes to display

wir - The work item record to build the form for

Returns:

true if form creation is successful

makeForm

boolean makeForm(java.lang.String title,
                 java.lang.String header,
                 java.lang.String schema,
                 java.util.List<YParameter> parameters)

Build and show a form to capture the input data values on a case start.

Parameters:

title - The form's title

header - A header text for the form top

schema - An XSD schema of the data types and attributes to display

parameters - a list of the root net's input parameters

Returns:

true if form creation is successful

getDataList

java.lang.String getDataList()

Gets the form's data list on completion of the form. The data list must be a well-formed XML string representing the expected data structure for the work item or case start. The opening and closing tag must be the name of task of which the work item is an instance, or of the root net name of the case instance.

Returns:

A well-formed XML String of the work item's output data values

getDocComponentIDs

java.util.List<java.lang.Long> getDocComponentIDs()

Gets a list of component identifiers that represent documents managed by the doc store service. Only for case-level forms. When a document is uploaded to the Document Store at case start, the upload occurs before the case has been launched and thus there is not yet a case id allocated. Once the case launch is successful, this method should be called to associate the case id with the already uploaded document.

Returns:

a List of Long identifiers