com.silverpeas.workflow.api.model
Interface State

All Known Implementing Classes:

StateImpl

public interface State

Interface describing a representation of the <state> element of a Process Model.

Method Summary

void	addActivity(ContextualDesignation description) Add an activity Method needed primarily by Castor
void	addDescription(ContextualDesignation description) Add a description Method needed primarily by Castor
void	addLabel(ContextualDesignation label) Add a label Method needed primarily by Castor
AllowedActions	createAllowedActions() Create and return an object implementing AllowedActions
ContextualDesignation	createDesignation() Create an object implementing ContextualDesignation Method needed primarily by Castor
QualifiedUsers	createQualifiedUsers() Create and return an object implementing QalifiedUsers
TimeOutActions	createTimeOutActions() Create and return an object implementing TimeOutActions
ContextualDesignations	getActivities() Get all the activities
String	getActivity(String role, String language) Get activity in specific language for the given role
Action[]	getAllowedActions() Get actions available in this state
AllowedActions	getAllowedActionsEx() Get all the allowed actions
String	getDescription(String role, String language) Get description in specific language for the given role
ContextualDesignations	getDescriptions() Get all the descriptions
Action[]	getFilteredActions()
QualifiedUsers	getInterestedUsers() Get all the users interested by this state
QualifiedUsers	getInterestedUsersEx() Get all the users interested by this state
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 state
Action	getTimeoutAction() Get the timeout action of this state Action that will played if timeout is trigerred
TimeOutAction[]	getTimeOutActions() Get timeout actions for this state
TimeOutActions	getTimeOutActionsEx() Get all the timeout actions
int	getTimeoutInterval() Get the timeout interval of this state
boolean	getTimeoutNotifyAdmin() Get flag for admin notification if true, the timeout manager will send a notification to all supervisors
QualifiedUsers	getWorkingUsers() Get all the users who can act in this state
QualifiedUsers	getWorkingUsersEx() Get all the users who can act in this state
Iterator<ContextualDesignation>	iterateActivity() Iterate through the activities
Iterator<ContextualDesignation>	iterateDescription() Iterate through the descriptions
Iterator<ContextualDesignation>	iterateLabel() Iterate through the Labels
void	setAllowedActions(AllowedActions allowedActions) Set the allowed actions
void	setFilteredActions(AllowedActions allowedActions)
void	setInterestedUsers(QualifiedUsers interestedUsers) Set the users interested by this state
void	setName(String name) Set the name of this state
void	setTimeoutAction(Action timeoutAction) Set the timeout action of this state Action that will played if timeout is trigerred
void	setTimeOutActions(TimeOutActions timeOutActions) Set the timeout actions
void	setTimeoutInterval(int iHours) Set the timeout interval of this state
void	setTimeoutNotifyAdmin(boolean timeoutAction) Set flag for admin notification if true, the timeout manager will send a notification to all supervisors
void	setWorkingUsers(QualifiedUsers workingUsers) Set the users who can act in this state

Method Detail

getName

String getName()

Get the name of this state

Returns:

state's name

setName

void setName(String name)

Set the name of this state

Parameters:

state - 's name

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

getActivity

String getActivity(String role,
                   String language)

Get activity in specific language for the given role

Parameters:

lang - activity's language

role - role for which the activity is

Returns:

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

getActivities

ContextualDesignations getActivities()

Get all the activities

Returns:

an object containing the collection of the activities

iterateActivity

Iterator<ContextualDesignation> iterateActivity()

Iterate through the activities

Returns:

an iterator

addActivity

void addActivity(ContextualDesignation description)

Add an activity 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

createAllowedActions

AllowedActions createAllowedActions()

Create and return an object implementing AllowedActions

createTimeOutActions

TimeOutActions createTimeOutActions()

Create and return an object implementing TimeOutActions

getTimeOutActions

TimeOutAction[] getTimeOutActions()

Get timeout actions for this state

Returns:

timeout actions

getAllowedActions

Action[] getAllowedActions()

Get actions available in this state

Returns:

allowedActions allowed actions

getFilteredActions

Action[] getFilteredActions()

getTimeOutActionsEx

TimeOutActions getTimeOutActionsEx()

Get all the timeout actions

Returns:

an object containing the collection of the timeout actions

setTimeOutActions

void setTimeOutActions(TimeOutActions timeOutActions)

Set the timeout actions

getAllowedActionsEx

AllowedActions getAllowedActionsEx()

Get all the allowed actions

Returns:

an object containing the collection of the allowed actions

setAllowedActions

void setAllowedActions(AllowedActions allowedActions)

Set the allowed actions

setFilteredActions

void setFilteredActions(AllowedActions allowedActions)

createQualifiedUsers

QualifiedUsers createQualifiedUsers()

Create and return an object implementing QalifiedUsers

getInterestedUsers

QualifiedUsers getInterestedUsers()

Get all the users interested by this state

Returns:

QualifiedUsers object containing interested users, or an empty QualifiedUsers object but never null

getInterestedUsersEx

QualifiedUsers getInterestedUsersEx()

Get all the users interested by this state

Returns:

QualifiedUsers object containing interested users, or null if none are defined

setInterestedUsers

void setInterestedUsers(QualifiedUsers interestedUsers)

Set the users interested by this state

getWorkingUsers

QualifiedUsers getWorkingUsers()

Get all the users who can act in this state

Returns:

QualifiedUsers object containing theses users, or an empty QualifiedUsers object but never null

getWorkingUsersEx

QualifiedUsers getWorkingUsersEx()

Get all the users who can act in this state

Returns:

QualifiedUsers object containing theses users, or null if none are defined

setWorkingUsers

void setWorkingUsers(QualifiedUsers workingUsers)

Set the users who can act in this state

getTimeoutInterval

int getTimeoutInterval()

Get the timeout interval of this state

Returns:

timeoutInterval interval in hours (as a int)

setTimeoutInterval

void setTimeoutInterval(int iHours)

Set the timeout interval of this state

Parameters:

iHours - interval in hours (as a int)

getTimeoutAction

Action getTimeoutAction()

Get the timeout action of this state Action that will played if timeout is trigerred

Returns:

timeout action

setTimeoutAction

void setTimeoutAction(Action timeoutAction)

Set the timeout action of this state Action that will played if timeout is trigerred

Parameters:

timeoutAction - timeout action

getTimeoutNotifyAdmin

boolean getTimeoutNotifyAdmin()

Get flag for admin notification if true, the timeout manager will send a notification to all supervisors

Returns:

admin notification flag

setTimeoutNotifyAdmin

void setTimeoutNotifyAdmin(boolean timeoutAction)

Set flag for admin notification if true, the timeout manager will send a notification to all supervisors

Parameters:

admin - notification flag