com.silverpeas.workflow.api.model
Interface Forms

All Known Implementing Classes:

FormsImpl

public interface Forms

Interface describing a representation of the <forms> element of a Process Model.

Method Summary

void	addForm(Form form) Add an form to the collection
Form	createForm() Create an Form
Form	getForm(String name) Get the form definition with given name.
Form	getForm(String name, String role) Get the form definition with given name for the given role, will return the form dedicated to that role or, if the former has not been found, a generic form with this name
Iterator<Form>	iterateForm() Iterate through the Form objects
void	removeForm(String strName, String strRole) Remove the form identified by name and role

Method Detail

iterateForm

Iterator<Form> iterateForm()

Iterate through the Form objects

Returns:

an iterator

addForm

void addForm(Form form)

Add an form to the collection

Parameters:

form - to be added

createForm

Form createForm()

Create an Form

Returns:

an object implementing Form

getForm

Form getForm(String name)

Get the form definition with given name. Works fine for forms other than 'presentationForm', since they have unique names.

Parameters:

name - action form

Returns:

form definition

getForm

Form getForm(String name,
             String role)

Get the form definition with given name for the given role, will return the form dedicated to that role or, if the former has not been found, a generic form with this name

Parameters:

name - action form

role - role name

Returns:

wanted form definition

removeForm

void removeForm(String strName,
                String strRole)
                throws WorkflowException

Remove the form identified by name and role

Parameters:

strName - the form name

strRole - the name of the role, may be null

Throws:

WorkflowException - if the role cannot be found