com.silverpeas.workflow.api.model
Interface QualifiedUsers

All Known Implementing Classes:

QualifiedUsersImpl

public interface QualifiedUsers

Interface describing a representation of one of the following elements of a Process Model:

• <workingUsers>
• <interestedUsers>

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 groups will be affected by default
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

Method Detail

getUserInRoles

UserInRole[] getUserInRoles()

Get the userInRoles

Returns:

the userInRoles as an array

iterateUserInRole

Iterator<UserInRole> iterateUserInRole()

Iterate through the UserInRole objects

Returns:

an iterator

createUserInRole

UserInRole createUserInRole()

Create a new UserInRole

Returns:

an object implementing UserInRole

addUserInRole

void addUserInRole(UserInRole user)

Add a UserInRole to the collection

Parameters:

user - to be added

getUserInRole

UserInRole getUserInRole(String strRoleName)

Get the userInRoles

Parameters:

strRoleName -

Returns:

the userInRoles as a Vector

removeUserInRoles

void removeUserInRoles()

Remove all UserInRole from the collection

getRelatedUsers

RelatedUser[] getRelatedUsers()

Get the participants and related users

Returns:

the participants and related users as an array

getRelatedUser

RelatedUser getRelatedUser(RelatedUser relatedUser)

Get the related user equivalent to the one specified

Parameters:

relatedUser - the reference to look for

Returns:

the related users as referenced or null

iterateRelatedUser

Iterator<RelatedUser> iterateRelatedUser()

Iterate through the RelatedUser objects

Returns:

an iterator

createRelatedUser

RelatedUser createRelatedUser()

Create a new RelatedUser

Returns:

an object implementing RelatedUser

addRelatedUser

void addRelatedUser(RelatedUser user)

Add a RelatedUser to the collection

Parameters:

user - to be added

removeRelatedUser

void removeRelatedUser(RelatedUser reference)
                       throws WorkflowException

Remove a RelatedUser from the collection

Parameters:

reference - the reference of the RelatedUser to be removed

Throws:

WorkflowException - when something goes wrong

getRelatedGroups

RelatedGroup[] getRelatedGroups()

Get the related groups

Returns:

the related groups as an array

getRelatedGroup

RelatedGroup getRelatedGroup(RelatedGroup relatedGroup)

Get the related group equivalent to the one specified

Parameters:

relatedGroup - the reference to look for

Returns:

the related groups as referenced or null

iterateRelatedGroup

Iterator<RelatedGroup> iterateRelatedGroup()

Iterate through the RelatedGroup objects

Returns:

an iterator

createRelatedGroup

RelatedGroup createRelatedGroup()

Create a new RelatedGroup

Returns:

an object implementing RelatedGroup

addRelatedGroup

void addRelatedGroup(RelatedGroup group)

Add a RelatedGroup to the collection

Parameters:

group - to be added

removeRelatedGroup

void removeRelatedGroup(RelatedGroup reference)
                        throws WorkflowException

Remove a RelatedGroup from the collection

Parameters:

reference - the reference of the RelatedGroup to be removed

Throws:

WorkflowException - when something goes wrong

getRole

String getRole()

Get the role to which the related groups will be affected by default

Returns:

the role name

setRole

void setRole(String role)

Set the role to which the related user will be affected

Parameters:

role - role as a String

getMessage

String getMessage()

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

Returns:

the message

setMessage

void setMessage(String message)

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

Parameters:

message - message as a String

getSenderId

String getSenderId()

Get the user id used as sender for message.

Returns: