com.silverpeas.workflow.engine.model
Class FormsImpl

java.lang.Object
  com.silverpeas.workflow.engine.model.FormsImpl

All Implemented Interfaces:

Forms, Serializable

public class FormsImpl
extends Object
implements Serializable, Forms

Class implementing the representation of the <forms> element of a Process Model.

See Also:

Serialized Form

Constructor Summary

FormsImpl()
Constructor

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormsImpl

public FormsImpl()

Constructor

Method Detail

addForm

public void addForm(Form form)

Description copied from interface: Forms

Add an form to the collection

Specified by:

addForm in interface Forms

Parameters:

form - to be added

createForm

public Form createForm()

Description copied from interface: Forms

Create an Form

Specified by:

createForm in interface Forms

Returns:

an object implementing Form

getForm

public Form getForm(String name)

Description copied from interface: Forms

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

Specified by:

getForm in interface Forms

Parameters:

name - action form

Returns:

form definition

getForm

public Form getForm(String name,
                    String role)

Description copied from interface: Forms

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

Specified by:

getForm in interface Forms

Parameters:

name - action form

role - role name

Returns:

wanted form definition

iterateForm

public Iterator<Form> iterateForm()

Description copied from interface: Forms

Iterate through the Form objects

Specified by:

iterateForm in interface Forms

Returns:

an iterator

removeForm

public void removeForm(String strName,
                       String strRole)
                throws WorkflowException

Description copied from interface: Forms

Remove the form identified by name and role

Specified by:

removeForm in interface Forms

Parameters:

strName - the form name

strRole - the name of the role, may be null

Throws:

WorkflowException - if the role cannot be found