com.silverpeas.workflow.api.model
Interface Consequence

All Known Implementing Classes:

ConsequenceImpl

public interface Consequence

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

Method Summary

void	addNotifiedUsers(QualifiedUsers notifyUsers) Add a new notifiedUser to the collection
void	addTargetState(StateSetter stateSetter) Add a new Target State to the collection
void	addUnsetState(StateSetter stateSetter) Add a new Unset State to the collection
StateSetter	createStateSetter() Create a new state Setter object
Triggers	createTriggers()
String	getItem() Get the item on which the comparison will be processed
boolean	getKill() Get the flag that specifies if instance has to be removed
List<QualifiedUsers>	getNotifiedUsers() Get all the users that have to be notified
String	getOperator() Get the operator used to compare item and value
State	getTargetState(String strStateName) Get the target state with the given state name
State[]	getTargetStates() Get the target states
Triggers	getTriggers()
State	getUnsetState(String strStateName) Get the state to un-set with the given state name
State[]	getUnsetStates() Get the states to un-set
String	getValue() Get the value to compare with item
boolean	isVerified(String itemValue) Check if the consequence is verified
Iterator<StateSetter>	iterateTargetState() Iterate through Target States.
Iterator<StateSetter>	iterateUnsetState() Iterate through Unset States.
void	setItem(String strName) Set the item on which the comparison will be processed
void	setKill(boolean kill) Set the flag that specifies if instance has to be removed
void	setNotifiedUsers(List<QualifiedUsers> notifiedUsersList) Set all the users that have to be notified
void	setOperator(String strOperator) Set the operator used to compare item and value
void	setValue(String strValue) Set the value to compare with item

Method Detail

getItem

String getItem()

Get the item on which the comparison will be processed

Returns:

the item name

setItem

void setItem(String strName)

Set the item on which the comparison will be processed

Parameters:

the - item

getOperator

String getOperator()

Get the operator used to compare item and value

Returns:

an operator (ie : =, >, >=, <, <=, !=)

setOperator

void setOperator(String strOperator)

Set the operator used to compare item and value

Parameters:

the - operator (ie : =, >, >=, <, <=, !=)

getValue

String getValue()

Get the value to compare with item

Returns:

the value

setValue

void setValue(String strValue)

Set the value to compare with item

Parameters:

the - value

isVerified

boolean isVerified(String itemValue)

Check if the consequence is verified

Returns:

true if comparison is verified, false otherwise.

getTargetStates

State[] getTargetStates()

Get the target states

Returns:

the target states as a Vector

getTargetState

State getTargetState(String strStateName)

Get the target state with the given state name

Parameters:

strStateName - the name of the state

Returns:

the target state or null if not found

iterateTargetState

Iterator<StateSetter> iterateTargetState()

Iterate through Target States.

Returns:

an Iterator

createStateSetter

StateSetter createStateSetter()

Create a new state Setter object

Returns:

a StateSetter object

addTargetState

void addTargetState(StateSetter stateSetter)

Add a new Target State to the collection

Parameters:

stateSetter - object to be added

getUnsetState

State getUnsetState(String strStateName)

Get the state to un-set with the given state name

Parameters:

strStateName - the name of the state

Returns:

the state to un-set or null if not found

getUnsetStates

State[] getUnsetStates()

Get the states to un-set

Returns:

the un-set states as a Vector

iterateUnsetState

Iterator<StateSetter> iterateUnsetState()

Iterate through Unset States.

Returns:

an Iterator

addUnsetState

void addUnsetState(StateSetter stateSetter)

Add a new Unset State to the collection

Parameters:

stateSetter - object to be added

addNotifiedUsers

void addNotifiedUsers(QualifiedUsers notifyUsers)

Add a new notifiedUser to the collection

Parameters:

stateSetter - object to be added

getKill

boolean getKill()

Get the flag that specifies if instance has to be removed

Returns:

true if instance has to be removed

setKill

void setKill(boolean kill)

Set the flag that specifies if instance has to be removed

Parameters:

kill - true if instance has to be removed

getNotifiedUsers

List<QualifiedUsers> getNotifiedUsers()

Get all the users that have to be notified

Returns:

QualifiedUsers object containing notified users or an empty QualifiedUsers object but never a null

setNotifiedUsers

void setNotifiedUsers(List<QualifiedUsers> notifiedUsersList)

Set all the users that have to be notified

Parameters:

QualifiedUsers - object containing notified users

createTriggers

Triggers createTriggers()

getTriggers

Triggers getTriggers()