com.ibm.task.api

Class PeopleAssignmentFactory

  1. java.lang.Object
  2. extended bycom.ibm.task.api.PeopleAssignmentFactory

  1. public class PeopleAssignmentFactory
  2. extends java.lang.Object
Factory to create people assignments, for example, an organizational entity.
Since:
6.2.0.3

Field Summary

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

Method Summary

Modifier and Type Method and Description
  1. GroupMembersAndUsers
createByGroupMembersAndUsers(java.util.List users,java.util.List groups,boolean includeSubGroups)
Creates an organizational entity from a list of groups and users.
  1. OrganizationalEntity
createByLiteralGroup(java.lang.String group)
Creates an organizational entity from a group of users.
  1. OrganizationalEntity
createByLiteralGroups(java.util.List groups)
Creates an organizational entity from groups of users.
  1. OrganizationalEntity
createByLiteralUsers(java.util.List userIDs)
Creates an organizational entity from a list of users.
  1. 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.
  1. Everybody
createEverybody()
Creates an everybody people assignment.
  1. static
  2. 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

  1. public static final java.lang.String COPYRIGHT
See Also:

Method Detail

newInstance

  1. public static PeopleAssignmentFactory newInstance( )
Returns the single instance of a PeopleAssignmentFactory.
Returns:
PeopleAssignmentFactory The PeopleAssignmentFactory object.

createEverybody

  1. public Everybody createEverybody( )
Creates an everybody people assignment.
Returns:
The Everybody object.

createByLiteralUsers

  1. public OrganizationalEntity createByLiteralUsers( java.util.List userIDs)
  2. throws ParameterNullException
  3. InvalidParameterException
Creates an organizational entity from a list of users.
Parameters:
userIDs - The users for this organizational entity.
Returns:
The organizational entity object.
Throws:

createByLiteralGroup

  1. public OrganizationalEntity createByLiteralGroup( java.lang.String group)
  2. 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:

createByLiteralGroups

  1. public OrganizationalEntity createByLiteralGroups( java.util.List groups)
  2. throws ParameterNullException
  3. 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:

createByLiteralUsersAndGroups

  1. public OrganizationalEntity createByLiteralUsersAndGroups( java.util.List userIDs,
  2. java.util.List groups)
  3. throws ParameterNullException
  4. 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:

createByGroupMembersAndUsers

  1. public GroupMembersAndUsers createByGroupMembersAndUsers( java.util.List users,
  2. java.util.List groups,
  3. boolean includeSubGroups)
  4. throws ParameterNullException
  5. 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: