com.silverpeas.workflow.api.model
Interface ProcessModel

All Known Implementing Classes:

ProcessModelImpl

public interface ProcessModel

Interface describing a representation of the main <processModel> element of a Process Model. The entry point to reading and manipulating the whole Process Model.

Method Summary

void	addDescription(ContextualDesignation description) Add a description Method needed primarily by Castor
void	addLabel(ContextualDesignation label) Add a label Method needed primarily by Castor
Actions	createActions() Create Actions
DataFolder	createDataFolder() Create DataFolder
ContextualDesignation	createDesignation() Create an object implementing ContextualDesignation Method needed primarily by Castor
Forms	createForms() Create Forms
Participants	createParticipants() Create Participants
Presentation	createPresentation() Create a Presentation
QualifiedUsers	createQualifiedUsers() Create an object implementing QualifiedUsers
RelatedUser	createRelatedUser() Create an object implementing RelatedUser
Roles	createRoles() Create Roles
States	createStates() Create States
Action	getAction(String name) Get the action definition with given name
Form	getActionForm(String actionName) Returns the form (if any) associated to the named action.
Action[]	getActions() Get the actions defined for this process model
Actions	getActionsEx() Get the actions definitions
RecordTemplate	getAllDataTemplate(String role, String lang) Returns the RecordTemplate which describes all the data of the process instance built from this model.
Action	getCreateAction(String role) Returns the action of kind create Throws a WorkflowException if there is no action of type create
String[]	getCreationRoles() Returns the roles under which an user can create a new instance
DataFolder	getDataFolder() Get the data folder defined for this process model
String	getDescription(String role, String language) Get description in specific language for the given role
ContextualDesignations	getDescriptions() Get all the descriptions
RecordSet	getFolderRecordSet() Returns the record set where are saved all the folder of the instance built from this model.
String	getFolderRecordSetName()
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
RecordSet	getFormRecordSet(String formName) Returns the record set where are saved all the data of the named form.
String	getFormRecordSetName(String formName)
Forms	getForms() Get the forms definitions
String	getLabel(String role, String language) Get label in specific language for the given role
ContextualDesignations	getLabels() Get all the labels
String	getModelId() Get the id of this process model
String	getName() Get the name of this process model
DataRecord	getNewActionRecord(String actionName, String roleName, String lang, DataRecord data) Returns an empty com.silverpeas.form.DataRecord which must be filled in order to process the named action.
DataRecord	getNewUserInfosRecord(String roleName, String lang) Returns an empty com.silverpeas.form.DataRecord which must be filled in order to fill the user information Throws a WorkflowException if problem encountered.
Participant[]	getParticipants() Get the participants definition
Participants	getParticipantsEx() Get all the participants definitions
Presentation	getPresentation() Get the presentation configuration
Form	getPresentationForm(String name, String role, String language) Returns the com.silverpeas.form.Form which be used to publish the named form.
Form	getPublicationForm(String actionName, String role, String language) Returns the com.silverpeas.form.Form which be used to publish the form associated to the named action.
Role	getRole(String name) Get the role definition with given name
Role[]	getRoles() Get the roles definition
Roles	getRolesEx() Get the Roles definitions
RecordTemplate	getRowTemplate(String role, String lang) Returns the RecordTemplate which describes a process instance in a row.
State	getState(String name) Get the state definition with given name
State[]	getStates() Get the states defined for this process model
States	getStatesEx() Get the states definitions
DataFolder	getUserInfos() Get the user infos defined for this process model
Iterator<ContextualDesignation>	iterateDescription() Iterate through the descriptions
Iterator<ContextualDesignation>	iterateLabel() Iterate through the Labels
void	setActions(Actions actions) Set the actions defined for this process model
void	setDataFolder(DataFolder dataFolder) Set the data folder for this process model
void	setForms(Forms forms) Set the forms defined for this process model
void	setModelId(String modelId) Set the id of this process model
void	setName(String name) Set the name of this process model
void	setParticipants(Participants participants) Set the participants definition
void	setPresentation(Presentation presentation) Set the presentation's configuration
void	setRoles(Roles roles) Set the roles definition
void	setStates(States states) Set the states defined for this process model
void	setUserInfos(DataFolder userInfos) Set the user infos defined for this process model It contains all the items necessary about user to allow him to use the instance

Method Detail

getModelId

String getModelId()

Get the id of this process model

Returns:

process model id

setModelId

void setModelId(String modelId)

Set the id of this process model

Parameters:

modelId - process model id

getName

String getName()

Get the name of this process model

Returns:

process model's name

setName

void setName(String name)

Set the name of this process model

Parameters:

name - model's name

getLabel

String getLabel(String role,
                String language)

Get label in specific language for the given role

Parameters:

language - label's language

role - role for which the label is

Returns:

wanted label as a String object. If label is not found, search label with given role and default language, if not found again, return the default label in given language, if not found again, return the default label in default language, if not found again, return empty string.

getLabels

ContextualDesignations getLabels()

Get all the labels

Returns:

an object containing the collection of the labels

iterateLabel

Iterator<ContextualDesignation> iterateLabel()

Iterate through the Labels

Returns:

an iterator

createDesignation

ContextualDesignation createDesignation()

Create an object implementing ContextualDesignation Method needed primarily by Castor

addLabel

void addLabel(ContextualDesignation label)

Add a label Method needed primarily by Castor

getDescription

String getDescription(String role,
                      String language)

Get description in specific language for the given role

Parameters:

lang - description's language

role - role for which the description is

Returns:

wanted description as a String object. If description is not found, search description with given role and default language, if not found again, return the default description in given language, if not found again, return the default description in default language, if not found again, return empty string.

getDescriptions

ContextualDesignations getDescriptions()

Get all the descriptions

Returns:

an object containing the collection of the descriptions

iterateDescription

Iterator<ContextualDesignation> iterateDescription()

Iterate through the descriptions

Returns:

an iterator

addDescription

void addDescription(ContextualDesignation description)

Add a description Method needed primarily by Castor

getPresentation

Presentation getPresentation()

Get the presentation configuration

Returns:

presentation configuration

setPresentation

void setPresentation(Presentation presentation)

Set the presentation's configuration

Parameters:

presentation - presentation's configuration

createPresentation

Presentation createPresentation()

Create a Presentation

Returns:

an object implementing Presentation

getParticipants

Participant[] getParticipants()

Get the participants definition

Returns:

participants definition

getParticipantsEx

Participants getParticipantsEx()

Get all the participants definitions

setParticipants

void setParticipants(Participants participants)

Set the participants definition

Parameters:

participants - participants definition

createParticipants

Participants createParticipants()

Create Participants

Returns:

an object implementing Participants

getRoles

Role[] getRoles()

Get the roles definition

Returns:

roles definition

getRolesEx

Roles getRolesEx()

Get the Roles definitions

getRole

Role getRole(String name)

Get the role definition with given name

Parameters:

name - role name

Returns:

wanted role definition

setRoles

void setRoles(Roles roles)

Set the roles definition

Parameters:

roles - roles definition

createRoles

Roles createRoles()

Create Roles

Returns:

an object implementing Roles

getStates

State[] getStates()

Get the states defined for this process model

Returns:

states defined for this process model

getStatesEx

States getStatesEx()

Get the states definitions

getState

State getState(String name)

Get the state definition with given name

Parameters:

name - state name

Returns:

wanted state definition

setStates

void setStates(States states)

Set the states defined for this process model

Parameters:

states - states defined for this process model

createStates

States createStates()

Create States

Returns:

an object implementing States

getActions

Action[] getActions()

Get the actions defined for this process model

Returns:

actions defined for this process model

getActionsEx

Actions getActionsEx()

Get the actions definitions

getAction

Action getAction(String name)
                 throws WorkflowException

Get the action definition with given name

Parameters:

name - action name

Returns:

wanted action definition

Throws:

WorkflowException

setActions

void setActions(Actions actions)

Set the actions defined for this process model

Parameters:

actions - actions defined for this process model

createActions

Actions createActions()

Create Actions

Returns:

an object implementing Actions

getDataFolder

DataFolder getDataFolder()

Get the data folder defined for this process model

Returns:

data folder defined for this process model. it contains all the items declarations

setDataFolder

void setDataFolder(DataFolder dataFolder)

Set the data folder for this process model

Parameters:

data - folder for this process model. it contains all the items declarations

createDataFolder

DataFolder createDataFolder()

Create DataFolder

Returns:

an object implementing DataFolder

getUserInfos

DataFolder getUserInfos()

Get the user infos defined for this process model

Returns:

user infos defined for this process model. It contains all the items necessary about user to allow him to use the instance

setUserInfos

void setUserInfos(DataFolder userInfos)

Set the user infos defined for this process model It contains all the items necessary about user to allow him to use the instance

Parameters:

userInfos - user infos defined for this process model.

getForms

Forms getForms()

Get the forms definitions

getForm

Form getForm(String name)

Get the form definition with given name

Parameters:

name - action form

Returns:

wanted form definition

getForm

Form getForm(String name,
             String role)

Get the form definition with given name for the given role

Parameters:

name - action form

Returns:

wanted form definition

setForms

void setForms(Forms forms)

Set the forms defined for this process model

Parameters:

forms - forms defined for this process model.

createForms

Forms createForms()

Create Forms

Returns:

an object implementing Forms

createQualifiedUsers

QualifiedUsers createQualifiedUsers()

Create an object implementing QualifiedUsers

createRelatedUser

RelatedUser createRelatedUser()

Create an object implementing RelatedUser

getFolderRecordSet

RecordSet getFolderRecordSet()
                             throws WorkflowException

Returns the record set where are saved all the folder of the instance built from this model.

Throws:

WorkflowException

getFolderRecordSetName

String getFolderRecordSetName()

getFormRecordSet

RecordSet getFormRecordSet(String formName)
                           throws WorkflowException

Returns the record set where are saved all the data of the named form.

Throws:

WorkflowException

getFormRecordSetName

String getFormRecordSetName(String formName)

getActionForm

Form getActionForm(String actionName)
                   throws WorkflowException

Returns the form (if any) associated to the named action. Returns null if the action has no form. Throws a WorkflowException if the action is unknown.

Throws:

WorkflowException

getPublicationForm

Form getPublicationForm(String actionName,
                        String role,
                        String language)
                        throws WorkflowException

Returns the com.silverpeas.form.Form which be used to publish the form associated to the named action. Returns null if the action has no form. Throws a WorkflowException if the action is unknown.

Throws:

WorkflowException

getCreateAction

Action getCreateAction(String role)
                       throws WorkflowException

Returns the action of kind create Throws a WorkflowException if there is no action of type create

Throws:

WorkflowException

getPresentationForm

Form getPresentationForm(String name,
                         String role,
                         String language)
                         throws WorkflowException

Returns the com.silverpeas.form.Form which be used to publish the named form. We can give an action name too. Returns null if the action exists but has no form. Throws a WorkflowException if the action/form is unknown.

Throws:

WorkflowException

getAllDataTemplate

RecordTemplate getAllDataTemplate(String role,
                                  String lang)

Returns the RecordTemplate which describes all the data of the process instance built from this model.

getRowTemplate

RecordTemplate getRowTemplate(String role,
                              String lang)

Returns the RecordTemplate which describes a process instance in a row.

getNewActionRecord

DataRecord getNewActionRecord(String actionName,
                              String roleName,
                              String lang,
                              DataRecord data)
                              throws WorkflowException

Returns an empty com.silverpeas.form.DataRecord which must be filled in order to process the named action. Returns null if no form is required to process this action. Throws a WorkflowException if the action is unknown.

Throws:

WorkflowException

getNewUserInfosRecord

DataRecord getNewUserInfosRecord(String roleName,
                                 String lang)
                                 throws WorkflowException

Returns an empty com.silverpeas.form.DataRecord which must be filled in order to fill the user information Throws a WorkflowException if problem encountered.

Throws:

WorkflowException

getCreationRoles

String[] getCreationRoles()
                          throws WorkflowException

Returns the roles under which an user can create a new instance

Throws:

WorkflowException