public class PeopleAssignmentFactory
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
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.
|
public static final java.lang.String COPYRIGHT
public static PeopleAssignmentFactory newInstance()
public Everybody createEverybody()
public OrganizationalEntity createByLiteralUsers(java.util.List userIDs) throws ParameterNullException, InvalidParameterException
userIDs
- The users for this organizational entity.ParameterNullException
InvalidParameterException
public OrganizationalEntity createByLiteralGroup(java.lang.String group) throws ParameterNullException
group
- The group for this organizational entity.ParameterNullException
public OrganizationalEntity createByLiteralGroups(java.util.List groups) throws ParameterNullException, InvalidParameterException
groups
- The groups for this organizational entity.ParameterNullException
InvalidParameterException
public OrganizationalEntity createByLiteralUsersAndGroups(java.util.List userIDs, java.util.List groups) throws ParameterNullException, InvalidParameterException
userIDs
- The non-empty list of users for this organizational entity.groups
- The non-empty list of groups for this organizational entity.InvalidParameterException
ParameterNullException
public GroupMembersAndUsers createByGroupMembersAndUsers(java.util.List users, java.util.List groups, boolean includeSubGroups) throws ParameterNullException, InvalidParameterException
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.ParameterNullException
InvalidParameterException