|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.silverpeas.workflow.engine.model.ProcessModelImpl
public class ProcessModelImpl
Class implementing the representation of the main <processModel> element of a Process Model.
Constructor Summary | |
---|---|
ProcessModelImpl()
Constructor |
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 with the 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 the data record 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()
Returns the name of the record set where are saved all the folder of the instance built from this model. |
Form |
getForm(String name)
Get the form with the 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)
Returns the name of the record set where are saved all the data of the named form. |
Forms |
getForms()
Get the forms definitions |
int |
getId()
|
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. |
AbstractDescriptor |
getParent()
|
Participant[] |
getParticipants()
Get the participants definition |
Participants |
getParticipantsEx()
Get all the participants definitions |
Presentation |
getPresentation()
Get the presentation configuration |
Presentation |
getPresentationForCastor()
Get the presentation configuration for Castor |
Form |
getPresentationForm(String name,
String roleName,
String lang)
Returns the com.silverpeas.form.Form which be used to publish the form associated to the named action or form. |
Form |
getPublicationForm(String actionName,
String roleName,
String lang)
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 the data record used to show process instance as a row in list. |
State |
getState(String name)
Get the state with the 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 It contains all the items necessary about user to allow him to use the instance |
boolean |
hasId()
|
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 defined for this process model |
void |
setForms(Forms forms)
Set the forms defined for this process model |
void |
setId(int id)
Implemented methods |
void |
setModelId(String modelId)
Set the id of this process model |
void |
setName(String name)
Set the name of this process model |
void |
setParent(AbstractDescriptor parent)
|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProcessModelImpl()
Method Detail |
---|
public String getModelId()
getModelId
in interface ProcessModel
public void setModelId(String modelId)
setModelId
in interface ProcessModel
name
- process model idpublic String getName()
getName
in interface ProcessModel
public void setName(String name)
setName
in interface ProcessModel
name
- process model's namepublic Presentation getPresentation()
getPresentation
in interface ProcessModel
public Presentation getPresentationForCastor()
null
public void setPresentation(Presentation presentation)
setPresentation
in interface ProcessModel
presentation
- presentation's configurationpublic Presentation createPresentation()
ProcessModel
createPresentation
in interface ProcessModel
public Participant[] getParticipants()
getParticipants
in interface ProcessModel
public Participants getParticipantsEx()
ProcessModel
getParticipantsEx
in interface ProcessModel
public void setParticipants(Participants participants)
setParticipants
in interface ProcessModel
participants
- participants definitionpublic Participants createParticipants()
ProcessModel
createParticipants
in interface ProcessModel
public Role[] getRoles()
getRoles
in interface ProcessModel
public Role getRole(String name)
getRole
in interface ProcessModel
name
- role name
public Roles getRolesEx()
ProcessModel
getRolesEx
in interface ProcessModel
public void setRoles(Roles roles)
setRoles
in interface ProcessModel
roles
- roles definitionpublic Roles createRoles()
ProcessModel
createRoles
in interface ProcessModel
public State[] getStates()
getStates
in interface ProcessModel
public States getStatesEx()
ProcessModel
getStatesEx
in interface ProcessModel
public State getState(String name)
getState
in interface ProcessModel
name
- state name
public void setStates(States states)
setStates
in interface ProcessModel
states
- states defined for this process modelpublic States createStates()
ProcessModel
createStates
in interface ProcessModel
public Action[] getActions()
getActions
in interface ProcessModel
public Actions getActionsEx()
ProcessModel
getActionsEx
in interface ProcessModel
public Action getAction(String name) throws WorkflowException
getAction
in interface ProcessModel
name
- action name
WorkflowException
public void setActions(Actions actions)
setActions
in interface ProcessModel
actions
- actions defined for this process modelpublic Actions createActions()
ProcessModel
createActions
in interface ProcessModel
public DataFolder getDataFolder()
getDataFolder
in interface ProcessModel
public void setDataFolder(DataFolder dataFolder)
setDataFolder
in interface ProcessModel
dataFolder
- data folder defined for this process model. it contains all the items
declarationspublic DataFolder createDataFolder()
ProcessModel
createDataFolder
in interface ProcessModel
public DataFolder getUserInfos()
getUserInfos
in interface ProcessModel
public void setUserInfos(DataFolder userInfos)
setUserInfos
in interface ProcessModel
userInfos
- user infos defined for this process model.public Forms getForms()
ProcessModel
getForms
in interface ProcessModel
public Form getForm(String name)
getForm
in interface ProcessModel
name
- form name
public Form getForm(String name, String role)
ProcessModel
getForm
in interface ProcessModel
name
- action form
public void setForms(Forms forms)
setForms
in interface ProcessModel
forms
- forms defined for this process model.public Forms createForms()
ProcessModel
createForms
in interface ProcessModel
public ContextualDesignation createDesignation()
ProcessModel
createDesignation
in interface ProcessModel
public ContextualDesignations getLabels()
ProcessModel
getLabels
in interface ProcessModel
public String getLabel(String role, String language)
getLabel
in interface ProcessModel
lang
- label's languagerole
- role for which the label is
public void addLabel(ContextualDesignation label)
ProcessModel
addLabel
in interface ProcessModel
public Iterator<ContextualDesignation> iterateLabel()
ProcessModel
iterateLabel
in interface ProcessModel
public ContextualDesignations getDescriptions()
ProcessModel
getDescriptions
in interface ProcessModel
public String getDescription(String role, String language)
getDescription
in interface ProcessModel
lang
- description's languagerole
- role for which the description is
public void addDescription(ContextualDesignation description)
ProcessModel
addDescription
in interface ProcessModel
public Iterator<ContextualDesignation> iterateDescription()
ProcessModel
iterateDescription
in interface ProcessModel
public QualifiedUsers createQualifiedUsers()
ProcessModel
createQualifiedUsers
in interface ProcessModel
public RelatedUser createRelatedUser()
ProcessModel
createRelatedUser
in interface ProcessModel
public String getFolderRecordSetName()
getFolderRecordSetName
in interface ProcessModel
public String getFormRecordSetName(String formName)
getFormRecordSetName
in interface ProcessModel
public RecordSet getFolderRecordSet() throws WorkflowException
getFolderRecordSet
in interface ProcessModel
WorkflowException
public RecordSet getFormRecordSet(String formName) throws WorkflowException
getFormRecordSet
in interface ProcessModel
WorkflowException
public Form getActionForm(String actionName) throws WorkflowException
getActionForm
in interface ProcessModel
WorkflowException
public Action getCreateAction(String role) throws WorkflowException
getCreateAction
in interface ProcessModel
WorkflowException
public Form getPublicationForm(String actionName, String roleName, String lang) throws WorkflowException
getPublicationForm
in interface ProcessModel
WorkflowException
public Form getPresentationForm(String name, String roleName, String lang) throws WorkflowException
getPresentationForm
in interface ProcessModel
WorkflowException
public DataRecord getNewActionRecord(String actionName, String roleName, String lang, DataRecord data) throws WorkflowException
getNewActionRecord
in interface ProcessModel
WorkflowException
public DataRecord getNewUserInfosRecord(String roleName, String lang) throws WorkflowException
getNewUserInfosRecord
in interface ProcessModel
WorkflowException
public String[] getCreationRoles() throws WorkflowException
getCreationRoles
in interface ProcessModel
WorkflowException
public RecordTemplate getAllDataTemplate(String role, String lang)
getAllDataTemplate
in interface ProcessModel
public RecordTemplate getRowTemplate(String role, String lang)
getRowTemplate
in interface ProcessModel
public void setId(int id)
setId
in interface AbstractDescriptor
public int getId()
getId
in interface AbstractDescriptor
public void setParent(AbstractDescriptor parent)
setParent
in interface AbstractDescriptor
public AbstractDescriptor getParent()
getParent
in interface AbstractDescriptor
public boolean hasId()
hasId
in interface AbstractDescriptor
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |