com.silverpeas.workflow.engine.model
Class QualifiedUsersImpl

java.lang.Object
  com.silverpeas.workflow.engine.model.QualifiedUsersImpl

All Implemented Interfaces:

QualifiedUsers, Serializable

public class QualifiedUsersImpl
extends Object
implements QualifiedUsers, Serializable

Class implementing the representation of the <allowedUsers>, <workingUsers>, <notifiedUsers> and <interestedUsers> elements of a Process Model.

See Also:

Serialized Form

Constructor Summary

QualifiedUsersImpl()
Constructor

Method Summary

void	addRelatedGroup(RelatedGroup group) Add a RelatedGroup to the collection
void	addRelatedUser(RelatedUser user) Add a RelatedUser to the collection
void	addUserInRole(UserInRole user) Add a UserInRole to the collection
RelatedGroup	createRelatedGroup() Create a new RelatedGroup
RelatedUser	createRelatedUser() Create a new RelatedUser
UserInRole	createUserInRole() Create a new UserInRole
String	getMessage() Get the message associated to the related users (only used for notification)
RelatedGroup	getRelatedGroup(RelatedGroup relatedGroup) Get the related group equivalent to the one specified
RelatedGroup[]	getRelatedGroups() Get the related groups
RelatedUser	getRelatedUser(RelatedUser relatedUser) Get the related user equivalent to the one specified
RelatedUser[]	getRelatedUsers() Get the participants and related users
String	getRole() Get the role to which the related user will be affected
String	getSenderId() Get the user id used as sender for message.
UserInRole	getUserInRole(String strRoleName) Get the userInRoles
UserInRole[]	getUserInRoles() Get the userInRoles
Iterator<RelatedGroup>	iterateRelatedGroup() Iterate through the RelatedGroup objects
Iterator<RelatedUser>	iterateRelatedUser() Iterate through the RelatedUser objects
Iterator<UserInRole>	iterateUserInRole() Iterate through the UserInRole objects
void	removeRelatedGroup(RelatedGroup reference) Remove a RelatedGroup from the collection
void	removeRelatedUser(RelatedUser reference) Remove a RelatedUser from the collection
void	removeUserInRoles() Remove all UserInRole from the collection
void	setMessage(String message) Set the message associated to the related users (only used for notification)
void	setRole(String role) Set the role to which the related user will be affected
void	setSenderId(String senderId) Set the user id used as sender for message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualifiedUsersImpl

public QualifiedUsersImpl()

Constructor

Method Detail

getUserInRole

public UserInRole getUserInRole(String strRoleName)

Get the userInRoles

Specified by:

getUserInRole in interface QualifiedUsers

Returns:

the userInRoles as a Vector

getUserInRoles

public UserInRole[] getUserInRoles()

Get the userInRoles

Specified by:

getUserInRoles in interface QualifiedUsers

Returns:

the userInRoles as an array

addUserInRole

public void addUserInRole(UserInRole user)

Description copied from interface: QualifiedUsers

Add a UserInRole to the collection

Specified by:

addUserInRole in interface QualifiedUsers

Parameters:

user - to be added

createUserInRole

public UserInRole createUserInRole()

Description copied from interface: QualifiedUsers

Create a new UserInRole

Specified by:

createUserInRole in interface QualifiedUsers

Returns:

an object implementing UserInRole

iterateUserInRole

public Iterator<UserInRole> iterateUserInRole()

Description copied from interface: QualifiedUsers

Iterate through the UserInRole objects

Specified by:

iterateUserInRole in interface QualifiedUsers

Returns:

an iterator

removeUserInRoles

public void removeUserInRoles()

Description copied from interface: QualifiedUsers

Remove all UserInRole from the collection

Specified by:

removeUserInRoles in interface QualifiedUsers

getRelatedUsers

public RelatedUser[] getRelatedUsers()

Get the participants and related users

Specified by:

getRelatedUsers in interface QualifiedUsers

Returns:

the participants and related users as an array

getRelatedGroups

public RelatedGroup[] getRelatedGroups()

Get the related groups

Specified by:

getRelatedGroups in interface QualifiedUsers

Returns:

the related groups as an array

getRelatedUser

public RelatedUser getRelatedUser(RelatedUser relatedUser)

Description copied from interface: QualifiedUsers

Get the related user equivalent to the one specified

Specified by:

getRelatedUser in interface QualifiedUsers

Parameters:

relatedUser - the reference to look for

Returns:

the related users as referenced or null

getRelatedGroup

public RelatedGroup getRelatedGroup(RelatedGroup relatedGroup)

Description copied from interface: QualifiedUsers

Get the related group equivalent to the one specified

Specified by:

getRelatedGroup in interface QualifiedUsers

Parameters:

relatedGroup - the reference to look for

Returns:

the related groups as referenced or null

addRelatedUser

public void addRelatedUser(RelatedUser user)

Description copied from interface: QualifiedUsers

Add a RelatedUser to the collection

Specified by:

addRelatedUser in interface QualifiedUsers

Parameters:

user - to be added

addRelatedGroup

public void addRelatedGroup(RelatedGroup group)

Description copied from interface: QualifiedUsers

Add a RelatedGroup to the collection

Specified by:

addRelatedGroup in interface QualifiedUsers

Parameters:

group - to be added

createRelatedUser

public RelatedUser createRelatedUser()

Description copied from interface: QualifiedUsers

Create a new RelatedUser

Specified by:

createRelatedUser in interface QualifiedUsers

Returns:

an object implementing RelatedUser

createRelatedGroup

public RelatedGroup createRelatedGroup()

Description copied from interface: QualifiedUsers

Create a new RelatedGroup

Specified by:

createRelatedGroup in interface QualifiedUsers

Returns:

an object implementing RelatedGroup

iterateRelatedUser

public Iterator<RelatedUser> iterateRelatedUser()

Description copied from interface: QualifiedUsers

Iterate through the RelatedUser objects

Specified by:

iterateRelatedUser in interface QualifiedUsers

Returns:

an iterator

iterateRelatedGroup

public Iterator<RelatedGroup> iterateRelatedGroup()

Description copied from interface: QualifiedUsers

Iterate through the RelatedGroup objects

Specified by:

iterateRelatedGroup in interface QualifiedUsers

Returns:

an iterator

removeRelatedUser

public void removeRelatedUser(RelatedUser reference)
                       throws WorkflowException

Description copied from interface: QualifiedUsers

Remove a RelatedUser from the collection

Specified by:

removeRelatedUser in interface QualifiedUsers

Parameters:

reference - the reference of the RelatedUser to be removed

Throws:

WorkflowException - when something goes wrong

removeRelatedGroup

public void removeRelatedGroup(RelatedGroup reference)
                        throws WorkflowException

Description copied from interface: QualifiedUsers

Remove a RelatedGroup from the collection

Specified by:

removeRelatedGroup in interface QualifiedUsers

Parameters:

reference - the reference of the RelatedGroup to be removed

Throws:

WorkflowException - when something goes wrong

getRole

public String getRole()

Get the role to which the related user will be affected

Specified by:

getRole in interface QualifiedUsers

Returns:

the role name

setRole

public void setRole(String role)

Description copied from interface: QualifiedUsers

Set the role to which the related user will be affected

Specified by:

setRole in interface QualifiedUsers

Parameters:

role - role as a String

getMessage

public String getMessage()

Get the message associated to the related users (only used for notification)

Specified by:

getMessage in interface QualifiedUsers

Returns:

the message

setMessage

public void setMessage(String message)

Set the message associated to the related users (only used for notification)

Specified by:

setMessage in interface QualifiedUsers

Parameters:

message - message as a String

getSenderId

public String getSenderId()

Get the user id used as sender for message.

Specified by:

getSenderId in interface QualifiedUsers

Returns:

setSenderId

public void setSenderId(String senderId)

Set the user id used as sender for message.

Parameters:

senderId - the user id