com.silverpeas.workflow.api.model
Interface Action

All Known Implementing Classes:

ActionImpl

public interface Action

Interface describing a representation of the <action> 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
Consequences	createConsequences() Create and return and object implementing Consequences
ContextualDesignation	createDesignation() Create an object implementing ContextualDesignation Method needed primarily by Castor
QualifiedUsers	createQualifiedUsers() Create and return an object implementing QalifiedUsers
QualifiedUsers	getAllowedUsers() Get all the users allowed to execute this action
Consequences	getConsequences() Get all the consequences of this action
String	getDescription(String role, String language) Get description in specific language for the given role
ContextualDesignations	getDescriptions() Get all the descriptions
Form	getForm() Get the form associated with this action
String	getKind() Get the kind of this action
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 action
Iterator<ContextualDesignation>	iterateDescription() Iterate through the descriptions
Iterator<ContextualDesignation>	iterateLabel() Iterate through the Labels
void	setAllowedUsers(QualifiedUsers allowedUsers) Set the list of users allowed to execute this action
void	setConsequences(Consequences consequences) Set the consequences of this action
void	setForm(Form form) Set the form associated with this action
void	setKind(String kind) Set the kind of this action
void	setName(String strName) Set the name of this action

Method Detail

getName

String getName()

Get the name of this action

Returns:

action's name

setName

void setName(String strName)

Set the name of this action

Parameters:

action - 's name

getKind

String getKind()

Get the kind of this action

Returns:

action's kind

setKind

void setKind(String kind)

Set the kind of this action

Parameters:

action - 's kind

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

createQualifiedUsers

QualifiedUsers createQualifiedUsers()

Create and return an object implementing QalifiedUsers

setAllowedUsers

void setAllowedUsers(QualifiedUsers allowedUsers)

Set the list of users allowed to execute this action

Parameters:

allowedUsers - allowed users

getAllowedUsers

QualifiedUsers getAllowedUsers()

Get all the users allowed to execute this action

Returns:

an array of User objects

getConsequences

Consequences getConsequences()

Get all the consequences of this action

Returns:

Consequences objects

createConsequences

Consequences createConsequences()

Create and return and object implementing Consequences

setConsequences

void setConsequences(Consequences consequences)

Set the consequences of this action

Parameters:

consequences -

getForm

Form getForm()

Get the form associated with this action

Returns:

Form object

setForm

void setForm(Form form)

Set the form associated with this action

Parameters:

Form - object