com.silverpeas.workflow.api.model
Interface Participant

All Known Implementing Classes:

ParticipantImpl

public interface Participant

Interface describing a representation of the <participant> element of a 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
ContextualDesignation	createDesignation() Create an object implementing ContextualDesignation Method needed primarily by Castor
String	getDescription(String role, String language) Get description in specific language for the given role
ContextualDesignations	getDescriptions() Get all the descriptions
String	getLabel(String role, String language) Get label in specific language for the given role
ContextualDesignations	getLabels() Get all the labels
String	getName() Get the name of this participant
String	getResolvedState() Get the state that defined participant has resolved
Iterator<ContextualDesignation>	iterateDescription() Iterate through the descriptions
Iterator<ContextualDesignation>	iterateLabel() Iterate through the Labels
void	setName(String name) Set the name of this participant
void	setResolvedState(String resolvedState) Set state that defined participant has resolved resolvedState state that defined participant has resolved

Method Detail

getName

String getName()

Get the name of this participant

Returns:

participant's name

setName

void setName(String name)

Set the name of this participant

Parameters:

participant - 's name

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

getLabel

String getLabel(String role,
                String language)

Get label in specific language for the given role

Parameters:

lang - 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

addLabel

void addLabel(ContextualDesignation label)

Add a label Method needed primarily by Castor

createDesignation

ContextualDesignation createDesignation()

Create an object implementing ContextualDesignation Method needed primarily by Castor

getResolvedState

String getResolvedState()

Get the state that defined participant has resolved

Returns:

state that defined participant has resolved

setResolvedState

void setResolvedState(String resolvedState)

Set state that defined participant has resolved resolvedState state that defined participant has resolved