com.ibm.task.api

Class PeopleAssignmentFactory

java.lang.Object

com.ibm.task.api.PeopleAssignmentFactory

public class PeopleAssignmentFactory
extends java.lang.Object

Factory to create people assignments, for example, an organizational entity.

Since:

6.2.0.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT

Method Summary

Methods

Modifier and Type	Method and Description
GroupMembersAndUsers	createByGroupMembersAndUsers(java.util.List users, java.util.List groups, boolean includeSubGroups) Creates an organizational entity from a list of groups and users.
OrganizationalEntity	createByLiteralGroup(java.lang.String group) Creates an organizational entity from a group of users.
OrganizationalEntity	createByLiteralGroups(java.util.List groups) Creates an organizational entity from groups of users.
OrganizationalEntity	createByLiteralUsers(java.util.List userIDs) Creates an organizational entity from a list of users.
OrganizationalEntity	createByLiteralUsersAndGroups(java.util.List userIDs, java.util.List groups) Creates an organizational entity from a list of users and a list of group of users.
Everybody	createEverybody() Creates an everybody people assignment.
static PeopleAssignmentFactory	newInstance() Returns the single instance of a PeopleAssignmentFactory.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

newInstance

public static PeopleAssignmentFactory newInstance()

Returns the single instance of a PeopleAssignmentFactory.

Returns:

PeopleAssignmentFactory The PeopleAssignmentFactory object.

createEverybody

public Everybody createEverybody()

Creates an everybody people assignment.

Returns:

The Everybody object.

createByLiteralUsers

public OrganizationalEntity createByLiteralUsers(java.util.List userIDs)
                                          throws ParameterNullException,
                                                 InvalidParameterException

Creates an organizational entity from a list of users.

Parameters:

userIDs - The users for this organizational entity.

Returns:

The organizational entity object.

Throws:

ParameterNullException

InvalidParameterException

createByLiteralGroup

public OrganizationalEntity createByLiteralGroup(java.lang.String group)
                                          throws ParameterNullException

Creates an organizational entity from a group of users. This organizational entity creates a so-called group work item. This means that you need to enable group work item support on the server.

Parameters:

group - The group for this organizational entity.

Returns:

The organizational entity object.

Throws:

ParameterNullException

createByLiteralGroups

public OrganizationalEntity createByLiteralGroups(java.util.List groups)
                                           throws ParameterNullException,
                                                  InvalidParameterException

Creates an organizational entity from groups of users. This organizational entity creates so-called group work items. This means that you need to enable group work item support on the server.

Parameters:

groups - The groups for this organizational entity.

Returns:

The organizational entity object.

Throws:

ParameterNullException

InvalidParameterException

createByLiteralUsersAndGroups

public OrganizationalEntity createByLiteralUsersAndGroups(java.util.List userIDs,
                                                 java.util.List groups)
                                                   throws ParameterNullException,
                                                          InvalidParameterException

Creates an organizational entity from a list of users and a list of group of users. You need to enable group work item support on the server to use this assignment type.

Parameters:

userIDs - The non-empty list of users for this organizational entity.

groups - The non-empty list of groups for this organizational entity.

Returns:

The organizational entity object.

Throws:

InvalidParameterException

ParameterNullException

createByGroupMembersAndUsers

public GroupMembersAndUsers createByGroupMembersAndUsers(java.util.List users,
                                                java.util.List groups,
                                                boolean includeSubGroups)
                                                  throws ParameterNullException,
                                                         InvalidParameterException

Creates an organizational entity from a list of groups and users. The groups are used to retrieve the user IDs specified by the group from the people directory. As a result of using this organizational entity, every member of the specified groups and every member of the specified list of users receives a work item.

Parameters:

groups - The groups for this organizational entity.

users - The users for this organizational entity.

includeSubGroups - Indicates whether members of subgroups should be included. True states that members of subgroups should be included. False states that members of subgroups should not be included. Note that this functionality depends on the support of the underlying people repository.

Returns:

The group members and users object.

Throws:

ParameterNullException

InvalidParameterException