com.arsdigita.workflow.simple
Interface Assignable

All Known Implementing Classes:

UserTask

public interface Assignable

Interface for assignment capability to a class.

Author:

Karl GoldStein, Khy Huang, Stefan Deusch

Field Summary

static String

versionId

Method Summary

void	assignGroup(Group group) Assigns a group of users to this task.
void	assignUser(User user) Assigns a user to this task.
Iterator	getAssignedGroups() Returns a GroupCollection over the set of groups assigned to this task.
Iterator	getAssignedUsers() Returns a UserCollection over the set of users assigned to this task.
boolean	isAssigned() Tests whether any user is assigned to this task.
boolean	isAssigned(Group group) Tests whether a group is assigned to this task.
boolean	isAssigned(User user) Tests whether a user is assigned to this task.
void	removeGroup(Group group) Removes a group from the task assignment list.
void	removeUser(User user) Removes a user from the task assignment list.

Field Detail

versionId

public static final String versionId

See Also:

Constant Field Values

Method Detail

assignUser

public void assignUser(User user)

Assigns a user to this task. (persistent operation)

Parameters:

user - an active user of the system

assignGroup

public void assignGroup(Group group)

Assigns a group of users to this task. (persistent operation)

Parameters:

group - a group of users

removeUser

public void removeUser(User user)

Removes a user from the task assignment list.

Parameters:

user - the user to remove

removeGroup

public void removeGroup(Group group)

Removes a group from the task assignment list.

Parameters:

group - the group to remove

isAssigned

public boolean isAssigned()

Tests whether any user is assigned to this task.

Returns:

true if anyone is assigned to this task; false otherwise.

isAssigned

public boolean isAssigned(User user)

Tests whether a user is assigned to this task.

Parameters:

user - a system user

Returns:

true if the user is assigned to this task; false otherwise.

isAssigned

public boolean isAssigned(Group group)

Tests whether a group is assigned to this task.

Parameters:

group - aA user group

Returns:

true if the group is assigned to this task; false otherwise.

getAssignedGroups

public Iterator getAssignedGroups()

Returns a GroupCollection over the set of groups assigned to this task.

Returns:

the groups assigned to this task.

getAssignedUsers

public Iterator getAssignedUsers()

Returns a UserCollection over the set of users assigned to this task.

Returns:

the users assigned to this task.