GroupService (Appian API)

All Superinterfaces:

ContextSensitiveSingletonService, Service
```
public interface GroupService
extends ContextSensitiveSingletonService
```
Provides the main functionality needed to create, update, delete, and get groups. Groups is an collaborative set of users and/or groups that allows mass updates for its members. For example, if a set of users will be working on a project together, and if one wants to give permissions to all these users or notify them, then it is easier to update en masse by granting privilges to the group and emailing the group. There are three group security types: public, personal and team. Public groups are visible to all users, and all users can apply to join. Personal groups are only visible to the group administrators, and all users must be added by the administrator. Team groups are visible to group members and users must be added by the group administrator. Group membership can be set explicitly or by using rules. A sample rule could be: all user's whose username starts with "m" are members. Every group can have at most one parent, as long as it is not recursive. That is A cannot be a parent of B, B a parent of C and C a parent of A. When a child group is created, it is automatically added as a member of the parent group. However, the parent group can have many member groups that do not have it as the parent group. There are three different membership policies: open, exclusive and closed. Open means that anyone can join. Exclusive means users can request to be added by the administrator. Closed means administrators can add. There are two viewing policies: high and low. High means that only administrators can see members, while low means members can see each other. "My Groups" is bookmark for a user's frequently used groups, so that these groups can be accessed quickly. Delegated creation means that a user is granted permission by the group Administrator to create groups with the delegated group as parent.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Integer`	`ACTION_GROUP_ADD_GROUP_MEMBERS` Constant for whether the user can add members to the group
`static java.lang.Integer`	`ACTION_GROUP_ADD_GROUP_RULES` Constant for whether the user can add group membership rules
`static java.lang.Integer`	`ACTION_GROUP_ADD_SELF_TO_GROUP` Constant for whether the user can add self to group
`static java.lang.Integer`	`ACTION_GROUP_DELETE_GROUP` Constant for whether the user can delete the group
`static java.lang.Integer`	`ACTION_GROUP_DELETE_GROUP_MEMBERS` Constant for whether the user can remove group members
`static java.lang.Integer`	`ACTION_GROUP_DELETE_GROUP_RULES` Constant for whether the user can delete group membership rules
`static java.lang.Integer`	`ACTION_GROUP_EDIT_GROUP_ATTRIBUTES` Constant for whether the user can edit group attributes
`static java.lang.Integer`	`ACTION_GROUP_REMOVE_SELF_FROM_GROUP` Constant for whether the user can remove his/her membership from group
`static java.lang.Integer`	`ACTION_GROUP_UPDATE_DELEGATED_ADMINISTRATION` Constant for whether the user can delegate group administration
`static java.lang.Integer`	`ACTION_GROUP_USE_GROUP_AS_DELEGATED_PARENT` Constant for whether the group can be delegated to be a parent group for creation of new groups
`static java.lang.Integer`	`ACTION_GROUP_VIEW_GROUP_ATTRIBUTES` Constant for whether the user can view the group attributes
`static java.lang.Integer`	`ACTION_GROUP_VIEW_GROUP_EXISTENCE` Constant for whether the user can check the existence of the group
`static java.lang.Integer`	`ACTION_GROUP_VIEW_GROUP_MEMBERS` Constant for whether the user can view group members
`static java.lang.Integer`	`ACTION_GROUP_VIEW_GROUP_RULES` Constant for whether the user can view the membership rules of the group
`static boolean`	`addAdminGroups$UPDATES`
`static boolean`	`addAdminUsers$UPDATES`
`static boolean`	`addGroupsToMyGroups$UPDATES`
`static boolean`	`addGroupToFavorites$UPDATES`
`static boolean`	`addMemberGroup$UPDATES`
`static boolean`	`addMemberGroups$UPDATES`
`static boolean`	`addMemberUser$UPDATES`
`static boolean`	`addMemberUsers$UPDATES`
`static boolean`	`addMyselfToGroup$UPDATES`
`static boolean`	`areGroupsAddedByRule$UPDATES`
`static boolean`	`areUsersAddedByRule$UPDATES`
`static boolean`	`areUsersMembersOfGroups$UPDATES`
`static boolean`	`canUseGroupName$UPDATES`
`static boolean`	`changeGroupTypeOfGroup$UPDATES`
`static boolean`	`changeGroupTypesOfGroups$UPDATES`
`static boolean`	`createGroup$UPDATES`
`static boolean`	`createGroups$UPDATES`
`static boolean`	`deleteGroup$UPDATES`
`static boolean`	`doesGroupExist$UPDATES`
`static boolean`	`findAdminGroups$UPDATES`
`static boolean`	`findAdminGroupsPaging$UPDATES`
`static boolean`	`findAvailableParentGroups$UPDATES`
`static boolean`	`findAvailableParentGroupsPaging$UPDATES`
`static boolean`	`findGroups$UPDATES`
`static boolean`	`findGroupsPaging$UPDATES`
`static boolean`	`findNonMemberAncestorGroups$UPDATES`
`static boolean`	`findNonMemberAncestorGroupsPaging$UPDATES`
`static boolean`	`getAdminGroupCount$UPDATES`
`static boolean`	`getAdminGroupsPaging$UPDATES`
`static boolean`	`getAdminUserCount$UPDATES`
`static boolean`	`getAdminUsersDirectPaging$UPDATES`
`static boolean`	`getAdminUsersPaging$UPDATES`
`static boolean`	`getAllAttributeTypes$UPDATES`
`static boolean`	`getApplicationName$UPDATES`
`static boolean`	`getCachedCredentials$UPDATES`
`static boolean`	`getCredentials$UPDATES`
`static boolean`	`getDirectAdminGroupIds$UPDATES`
`static boolean`	`getDirectAdminUsernames$UPDATES`
`static boolean`	`getDirectMemberGroupIds$UPDATES`
`static boolean`	`getDirectMemberUsernames$UPDATES`
`static boolean`	`getFavoriteGroups$UPDATES`
`static boolean`	`getGlobalHomePage$UPDATES`
`static boolean`	`getGroup$UPDATES`
`static boolean`	`getGroupActions$UPDATES`
`static boolean`	`getGroupAttribute$UPDATES`
`static boolean`	`getGroupIdsForUserByRole$UPDATES`
`static boolean`	`getGroupIdsForUserByRoles$UPDATES`
`static boolean`	`getGroupMembershipPolicyTypes$UPDATES`
`static boolean`	`getGroupMemberViewingPolicyTypes$UPDATES`
`static boolean`	`getGroupName$UPDATES`
`static boolean`	`getGroupNames$UPDATES`
`static boolean`	`getGroupNamesList$UPDATES`
`static boolean`	`getGroups$UPDATES`
`static boolean`	`getGroupSecurityTypes$UPDATES`
`static boolean`	`getGroupsForUserByRole$UPDATES`
`static boolean`	`getGroupsForUserByRolePaging$UPDATES`
`static boolean`	`getGroupsForUserByRoles$UPDATES`
`static boolean`	`getGroupsForUserByRolesPaging$UPDATES`
`static boolean`	`getGroupsList$UPDATES`
`static boolean`	`getGroupsOfType$UPDATES`
`static boolean`	`getGroupsOfTypeForMemberUser$UPDATES`
`static boolean`	`getGroupsOfTypePaging$UPDATES`
`static boolean`	`getGroupSummaryForUser$UPDATES`
`static boolean`	`getGroupSummaryForUserPaging$UPDATES`
`static boolean`	`getGroupTypeForGroup$UPDATES`
`static boolean`	`getMemberGroupCount$UPDATES`
`static boolean`	`getMemberGroups$UPDATES`
`static boolean`	`getMemberGroupsDirect$UPDATES`
`static boolean`	`getMemberGroupsDirectPaging$UPDATES`
`static boolean`	`getMemberGroupsPaging$UPDATES`
`static boolean`	`getMemberUserCount$UPDATES`
`static boolean`	`getMemberUsernames$UPDATES`
`static boolean`	`getMemberUsernamesDirect$UPDATES`
`static boolean`	`getMemberUsers$UPDATES`
`static boolean`	`getMemberUsersDirect$UPDATES`
`static boolean`	`getMemberUsersDirectPaging$UPDATES`
`static boolean`	`getMemberUsersPaging$UPDATES`
`static boolean`	`getMyGroupIds$UPDATES`
`static boolean`	`getMyGroups$UPDATES`
`static boolean`	`getMyHomePage$UPDATES`
`static boolean`	`getParentGroupsForDelegatedCreation$UPDATES`
`static boolean`	`getParentGroupsForDelegatedCreationPaging$UPDATES`
`static boolean`	`getParentGroupsForDelegatedUpdate$UPDATES`
`static boolean`	`getRootTrees$UPDATES`
`static boolean`	`getRootTreesSameTypeWithRoles$UPDATES`
`static boolean`	`getRuleSetForGroup$UPDATES`
`static boolean`	`getSystemDefaultApplication$UPDATES`
`static boolean`	`getTopLevelGroupsForHierarchy$UPDATES`
`static boolean`	`getTopLevelGroupsForHierarchyPaging$UPDATES`
`static boolean`	`getTopLevelGroupsPaging$UPDATES`
`static boolean`	`getTreeViewForGroup$UPDATES`
`static boolean`	`getTreeViewForGroupSameTypeWithRoles$UPDATES`
`static boolean`	`getUserDefaultApplication$UPDATES`
`static boolean`	`getWorkspace$UPDATES`
`static java.lang.Integer`	`GROUP_TYPE_CHANGE_INVALID_GROUP` Constant for InvalidGroupException where group Id is invalid.
`static java.lang.Integer`	`GROUP_TYPE_CHANGE_INVALID_GROUPTYPE` Constant for InvalidGroupTypeException when grouptype of group is invalid
`static java.lang.Integer`	`GROUP_TYPE_CHANGE_NO_PRIVILEGE` Constant for PrivilegeException where user cannot change group type of group
`static java.lang.Integer`	`GROUP_TYPE_CHANGE_SUCCESS` Constant for whether changing the group type of group was successful
`static boolean`	`isGroupDescendant$UPDATES`
`static boolean`	`isGroupSystemGroup$UPDATES`
`static boolean`	`isMemberOfGroups$UPDATES`
`static boolean`	`isUserMember$UPDATES`
`static boolean`	`isUserMemberOfGroups$UPDATES`
`static java.lang.String`	`RELATIONSHIP_TYPE_HEIRARCHY`
`static boolean`	`removeAdminGroups$UPDATES`
`static boolean`	`removeAdminUsers$UPDATES`
`static boolean`	`removeGroupFromFavorites$UPDATES`
`static boolean`	`removeGroupsFromMyGroups$UPDATES`
`static boolean`	`removeMemberGroup$UPDATES`
`static boolean`	`removeMemberGroups$UPDATES`
`static boolean`	`removeMemberUser$UPDATES`
`static boolean`	`removeMemberUsers$UPDATES`
`static boolean`	`removeMyselfFromGroup$UPDATES`
`static boolean`	`resolveEmailAddress$UPDATES`
`static boolean`	`resolveEmailAddresses$UPDATES`
`static boolean`	`resolveEmailDestinations$UPDATES`
`static boolean`	`setGlobalHomePage$UPDATES`
`static boolean`	`setHomePageForUser$UPDATES`
`static boolean`	`setMyHomePage$UPDATES`
`static boolean`	`suggest$UPDATES`
`static boolean`	`suggestGroups$UPDATES`
`static boolean`	`suggestGroupsBulk$UPDATES`
`static boolean`	`suggestUsersAndGroups$UPDATES`
`static boolean`	`suggestUsersAndGroupsBulk$UPDATES`
`static boolean`	`updateGroup$UPDATES`
`static boolean`	`updateGroups$UPDATES`
`static boolean`	`updateRuleSetForGroup$UPDATES`
`static java.lang.Integer`	`USER_ROLE_ADMINISTRATOR`
`static java.lang.Integer`	`USER_ROLE_CREATOR`
`static java.lang.Integer`	`USER_ROLE_MEMBER`
`static java.lang.Integer`	`USER_ROLE_NONMEMBER`
`static java.lang.Integer`	`USER_ROLE_SUPERADMIN`
`static java.lang.Integer`	`USER_ROLE_VIEWER`
`static boolean`	`validateTypedValues$UPDATES`

Fields inherited from interface com.appiancorp.services.ContextSensitiveSingletonService
CONFIGURE_METHOD_NAME

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAdminGroups(java.lang.Long[] adminGroupIds_, java.lang.Long groupId_)` Adds the given groups as administrator groups for group given by `groupId_`
`void`	`addAdminUsers(java.lang.String[] usernames_, java.lang.Long groupId_)` Adds the users by given username's as administrators of group given by `groupId_`
`void`	`addGroupsToMyGroups(java.lang.Long[] groupIds_)` Adds a list of groups to My Groups for logged in user.
`void`	`addGroupToFavorites(java.lang.Long groupId_)` Associates `Group` as one of the current `User`'s favorites
`void`	`addMemberGroup(java.lang.Long memgroupId_, java.lang.Long groupId_)` Adds a member group to a group.
`void`	`addMemberGroups(java.lang.Long[] memgroupIds_, java.lang.Long groupId_)` Adds member groups to a group
`void`	`addMemberUser(java.lang.String username_, java.lang.Long groupId_)` Adds a member user to a group .
`void`	`addMemberUsers(java.lang.String[] usernames_, java.lang.Long groupId_)` Adds member users to a group
`void`	`addMyselfToGroup(java.lang.Long groupId_)` Adds oneself to the given group
`boolean[]`	`areGroupsAddedByRule(java.lang.Long groupId_, java.lang.Long[] groupIds_)` Checks to see if the given groups were added to the group by a rule.
`boolean[]`	`areUsersAddedByRule(java.lang.Long groupId_, java.lang.String[] userIds_)` Checks to see if the given users where added to the group by a rule.
`boolean[][]`	`areUsersMembersOfGroups(java.lang.String[] usernames, java.lang.Long[] groupIds)` Determines if the specified user is a member of each of the specified groups.
`boolean[][]`	`areUsersMembersOfGroups(java.lang.String[] usernames, java.lang.String[] groupUuid_)` Determines if the specified user is a member of each of the specified groups.
`boolean`	`canUseGroupName(java.lang.String groupName_, java.lang.Long groupSecurityType_)` Indicates whether a user can create a new group with the given name of the given group security type.
`void`	`changeGroupTypeOfGroup(java.lang.Long groupId, java.lang.Long newGroupTypeId)` Changes the GroupType of a Group.
`java.lang.Integer[]`	`changeGroupTypesOfGroups(java.lang.Long[] groupIds, java.lang.Long[] newGroupTypeIds)` Changes the GroupTypes of Groups.
`java.lang.Long`	`createGroup(Group group_)` Create a new group.
`java.lang.Long[]`	`createGroups(Group[] groups_)` Create new groups.
`void`	`deleteGroup(java.lang.Long groupId_)` Deletes a single group.
`boolean`	`doesGroupExist(java.lang.Long groupId_)` Checks to see if a given group exists.
`Group[]`	`findAdminGroups(GroupSearch groupSearch_, boolean caseSensitive_)` Deprecated. use `findAdminGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`findAdminGroupsPaging(GroupSearch groupSearch_, boolean caseSensitive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Finds all groups of which you are administrator and which also match the given search criteria.
`Group[]`	`findAvailableParentGroups(GroupSearch groupSearch_, boolean caseSensitive_, java.lang.Long groupId_)` Deprecated. use `findAvailableParentGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`findAvailableParentGroupsPaging(GroupSearch groupSearch_, boolean caseSensitive_, java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of all groups available for setting as parent.
`Group[]`	`findGroups(GroupSearch groupSearch_, boolean caseSensitive_)` Deprecated. use `findGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`findGroupsPaging(GroupSearch groupSearch_, boolean caseSensitive_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Finds groups based on criteria submitted in the GroupSearch The supported search operators are specified in GroupSearch for a `group` See `getOperatorsForAttributeType()` in `GroupTypeService` to obtain a list of possible operators `Operator` for a given data type.
`Group[]`	`findNonMemberAncestorGroups(GroupSearch groupSearch_, boolean caseSensitive_, java.lang.Long groupId_)` Deprecated. use `findNonMemberAncestorGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead.
`ResultPage`	`findNonMemberAncestorGroupsPaging(GroupSearch groupSearch_, boolean caseSensitive_, java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Retrieves a `ResultPage` of list of groups for a group search that are not ancestors (by parent-member relationship) of the given group.
`int`	`getAdminGroupCount(java.lang.Long groupId_)` Gets the number of distinct groups {that are administrators of the specified group.
`ResultPage`	`getAdminGroupsPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Retrieves the groups that are administrator groups for the given `groupId_`
`int`	`getAdminUserCount(java.lang.Long groupId_)` Gets a count of distinct users that are administrators of the specified group.
`ResultPage`	`getAdminUsersDirectPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of distinct users that are direct admins of the specified group ie user admins of subgroups are not included.
`ResultPage`	`getAdminUsersPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Retrieves the users that are administrator users for the given `groupId_`
`AttributeType[]`	`getAllAttributeTypes()` Gets the list of group attribute types in the system
`java.lang.String`	`getApplicationName()` Gets the name of the application on which this service is running.
`Credentials`	`getCachedCredentials()` Returns the cached Credentials bean containing the group membership relations for the user in this Service Context.
`Credentials`	`getCredentials()` Returns a Credentials bean directly from the back-end, containing the group membership relations for the user in this Service Context.
`java.lang.Long[]`	`getDirectAdminGroupIds(java.lang.Long groupId)` Gets the group IDs of all the administrator groups added directly to a given group (excludes those who are administrators via membership in an administrator group)
`java.lang.String[]`	`getDirectAdminUsernames(java.lang.Long groupId)` Gets the usernames of all the administrator users added directly to a given group (excludes those who are administrators via membership in an administrator group)
`java.lang.Long[]`	`getDirectMemberGroupIds(java.lang.Long groupId)` Gets the group IDs of all the member groups added directly to a given group (excludes those who are members via rule or via membership in a member group)
`java.lang.String[]`	`getDirectMemberUsernames(java.lang.Long groupId)` Gets the usernames of all the member users added directly to a given group (excludes those who are members via rule or via membership in a member group)
`ResultPage`	`getFavoriteGroups(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of groups for the current user's Favorite Groups.
`java.lang.String`	`getGlobalHomePage()` Gets the global home page for the application.
`Group`	`getGroup(java.lang.Long groupId_)` Get a group by id.
`java.lang.Boolean[]`	`getGroupActions(java.lang.Long groupId_, java.lang.Integer[] actionIds_)` Gets s Boolean array, representing whether actions with the given ids can be performed on a given group by the current user
`Attribute`	`getGroupAttribute(java.lang.Long groupId_, java.lang.String attributeName_)` Gets a group attribute for a given group id.
`java.lang.Long[]`	`getGroupIdsForUserByRole(java.lang.String username_, java.lang.Integer role_)` Gets a list of group ids for which a given user has a given role.
`java.lang.Long[][]`	`getGroupIdsForUserByRoles(java.lang.String username_, java.lang.Integer[] roles_)` Gets the group Ids for which the specified user has any of the specified roles
`GroupMemberPolicy[]`	`getGroupMembershipPolicyTypes(java.lang.Long groupSecurityTypeId_)` Gets the list of group membership policy types for a particular group security type.
`GroupMemberViewingPolicy[]`	`getGroupMemberViewingPolicyTypes(java.lang.Long groupSecurityTypeId_)` Gets the list of group member viewing policies for a particular group security type.
`java.lang.String`	`getGroupName(java.lang.Long groupId_)` Gets a group name for a given group id.
`java.lang.String[]`	`getGroupNames(java.lang.Long[] groupIds_)` Gets a list of group names for a given list of group ids.
`ResultList`	`getGroupNamesList(java.lang.Long[] groupIds_)` Gets a list of group names for a given list of group ids.
`Group[]`	`getGroups(java.lang.Long[] groupIds_)` Gets a list of groups for a given list of group ids.
`GroupSecurityType[]`	`getGroupSecurityTypes(java.lang.Integer actionId_)` Gets the list of group security types that are available for a particular action.
`Group[]`	`getGroupsForUserByRole(java.lang.String username_, java.lang.Integer role_)` Gets a list of groups for which a given user has a given role.
`ResultPage`	`getGroupsForUserByRolePaging(java.lang.String username_, java.lang.Integer role_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing list of groups for which a given user has a given role.
`Group[]`	`getGroupsForUserByRoles(java.lang.String username_, java.lang.Integer[] roles_)` Deprecated. Use `getGroupsForUserByRolesPaging(String, Integer[], int, int, Integer, Integer)` instead.
`ResultPage`	`getGroupsForUserByRolesPaging(java.lang.String username_, java.lang.Integer[] roles_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Retrieves a ResultPage containing the list of groups for which the given user has any of the given roles.
`ResultList`	`getGroupsList(java.lang.Long[] groupIds_)` Returns a ResultList `ResultList` containing error codes for all Ids and `Group`s for valid Ids
`Group[]`	`getGroupsOfType(java.lang.Long groupTypeId_)` Deprecated. use `getGroupsOfTypePaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`Group[]`	`getGroupsOfTypeForMemberUser(java.lang.Long[] groupTypeIds_, java.lang.String username_)` Deprecated. Use `getGroupsForUserByRolePaging(String, Integer, int, int, Integer, Integer)` and extract groups of the desired types from the results.
`ResultPage`	`getGroupsOfTypePaging(java.lang.Long groupTypeId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of groups for a given group type
`GroupSummary[]`	`getGroupSummaryForUser(java.lang.String username_)` Deprecated. Use `getGroupSummaryForUserPaging(String, int, int, Integer, Integer)` instead.
`ResultPage`	`getGroupSummaryForUserPaging(java.lang.String username_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Retrieves `GroupSummary` beans for every group for which the given `User` is a member or administrator.
`java.lang.Long[]`	`getGroupTypeForGroup(java.lang.Long[] groupIds_)` Gets group types for a list of groups.
`int`	`getMemberGroupCount(java.lang.Long groupId_)` Gets the number of distinct groups {that are members of the specified group.
`Group[]`	`getMemberGroups(java.lang.Long groupId_)` Gets a list of members groups of a group
`Group[]`	`getMemberGroupsDirect(java.lang.Long groupId_)` Gets group members of a group that are explicitly defined, no cascading (group members of subgroups are not included)
`ResultPage`	`getMemberGroupsDirectPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of groups that are direct members, i.e. group members of subgroups are not included in the result set.
`ResultPage`	`getMemberGroupsPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of group members of a group
`int`	`getMemberUserCount(java.lang.Long groupId_)` Gets a count of distinct users that are members of the specified group.
`java.lang.String[]`	`getMemberUsernames(java.lang.Long groupId_)` Gets the usernames of all the member users for given group
`java.lang.String[]`	`getMemberUsernamesDirect(java.lang.Long groupId_)` Deprecated. Use `getMemberUsersDirectPaging(Long, int, int, Integer, Integer)`
`User[]`	`getMemberUsers(java.lang.Long groupId_)` Gets a list of member users of the specified group
`User[]`	`getMemberUsers(java.lang.Long[] groupIds_)` Gets a list of distinct users that are members of any of the specified groups.
`User[]`	`getMemberUsersDirect(java.lang.Long groupId_)` Deprecated. Use `getMemberUsersDirectPaging(Long, int, int, Integer, Integer)`
`ResultPage`	`getMemberUsersDirectPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of distinct users that are direct members of the specified group i.e user members of subgroups are not included.
`ResultPage`	`getMemberUsersPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage containing a list of member users of the specified group
`java.lang.Long[]`	`getMyGroupIds()` Gets Ids for logged-in user's My Groups.
`ResultPage`	`getMyGroups(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. use getFavoriteGroups
`java.lang.String`	`getMyHomePage()` Gets the home page for the current user if he has set one, otherwise returns the global home page.
`Group[]`	`getParentGroupsForDelegatedCreation()` Gets the groups for which the logged-in user is authorized to set as a parent when creating public child groups.
`ResultPage`	`getParentGroupsForDelegatedCreationPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets a ResultPage of parent groups for which the logged-in user is authorized to create public child groups.
`Group[]`	`getParentGroupsForDelegatedUpdate(java.lang.Long groupId_)` Gets the groups for which the logged-in user is authorized to set as parent when updating public child groups.
`Tree[]`	`getRootTrees(java.lang.Long groupTypeId_, java.lang.String relationshipType_, boolean singleGroupType_, int descendentDepth_)` Get a set of groups structured into one or more trees.
`Tree[]`	`getRootTrees(java.lang.Long groupTypeId_, java.lang.String relationshipType_, java.lang.Long[] groupTypeIds_, int descendentDepth_)` Get a set of groups structured into one or more trees
`Tree[]`	`getRootTreesSameTypeWithRoles(java.lang.Long groupTypeId_, java.lang.Integer[] roleTypes_, int descendantDepth_)` Get a set of groups `Group` structured into one or more trees `Tree`.
`RuleSet`	`getRuleSetForGroup(java.lang.Long groupId_)` Gets membership rule set for a Group
`java.lang.Long`	`getSystemDefaultApplication()` Deprecated. Use `ApplicationService.getDefaultApplication()`
`GroupHierarchyBean[]`	`getTopLevelGroupsForHierarchy(java.lang.Long groupTypeId_, boolean sameType_)`
`ResultPage`	`getTopLevelGroupsForHierarchyPaging(java.lang.Long groupTypeId_, boolean sameType_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Gets all top level `GroupHierarchyBean` objects ( `Group`s without a parent group) given the `Group` type.
`ResultPage`	`getTopLevelGroupsPaging(java.lang.Long groupTypeId_, java.lang.String relationshipType_, boolean singleGroupType_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Get a ResultPage containing a list of groups structured into one or more trees in the `result` field.
`TreePivot`	`getTreeViewForGroup(java.lang.Long groupId_, boolean singleGroupType_, java.lang.String relationshipType_, int descendentDepth_)` Get a view into the tree pivoted at a particular group.
`TreePivot`	`getTreeViewForGroup(java.lang.Long groupId_, java.lang.Long[] groupTypeIds_, java.lang.String relationshipType_, int descendentDepth_)` Get a view into the tree pivoted at a particular group Each node in the tree will represent a group.
`TreePivot`	`getTreeViewForGroupSameTypeWithRoles(java.lang.Long groupId_, java.lang.Integer[] roleTypes_, int descendantDepth_)` Get a view into the tree pivoted at a particular group Each node in the tree will represent a group.
`java.lang.Long`	`getUserDefaultApplication(java.lang.String username)` Deprecated. Use `ApplicationService.getDefaultApplication()` for the site-wide default.
`java.lang.String[]`	`getWorkspace()` Gets the current memory profile for the workspace.
`boolean`	`isGroupDescendant(java.lang.Long groupId_, java.lang.Long parentGroupId_)` Checks if a group is a descendant of another group (by parent-child relationship).
`boolean`	`isGroupSystemGroup(java.lang.Long groupId_)` Checks to see if a given group is a system group.
`boolean[]`	`isMemberOfGroups(java.lang.Long[] groupId_)` Determines if the current user is a member of each of the specified groups.
`boolean[]`	`isMemberOfGroups(java.lang.String[] groupUuid_)` Determines if the current user is a member of each of the specified groups.
`boolean`	`isUserMember(java.lang.String[] username_, java.lang.Long groupId_)` Checks multiple potential usernames to determine if a user is a member of a group
`boolean`	`isUserMember(java.lang.String[] username_, java.lang.String groupUuid_)` Checks multiple potential usernames to determine if a user is a member of a group
`boolean`	`isUserMember(java.lang.String username_, java.lang.Long groupId_)` Checks if a user is a member of a group
`boolean`	`isUserMember(java.lang.String username_, java.lang.String groupUuid_)` Checks if a user is a member of a group
`boolean[]`	`isUserMemberOfGroups(java.lang.String[] usernames, java.lang.Long[] groupId_)` Determines if the specified user is a member of each of the specified groups.
`boolean[]`	`isUserMemberOfGroups(java.lang.String[] usernames, java.lang.String[] groupUuid_)` Determines if the specified user is a member of each of the specified groups.
`boolean[]`	`isUserMemberOfGroups(java.lang.String username_, java.lang.Long[] groupId_)` Determines if the specified user is a member of each of the specified groups.
`boolean[]`	`isUserMemberOfGroups(java.lang.String username_, java.lang.String[] groupUuid_)` Determines if the specified user is a member of each of the specified groups.
`void`	`removeAdminGroups(java.lang.Long[] adminGroupIds_, java.lang.Long groupId_)` Removes the groups specified by adminGroupIds_ as administrators of group
`void`	`removeAdminUsers(java.lang.String[] usernames_, java.lang.Long groupId_)` Removes the users specified by `usernames_` as administrators of group
`void`	`removeGroupFromFavorites(java.lang.Long groupId_)` removes this group (groupId_) as one of the current user's favorites
`void`	`removeGroupsFromMyGroups(java.lang.Long[] groupIds_)` Removes a list of groups from My Groups for logged-in user.
`void`	`removeMemberGroup(java.lang.Long memgroupId_, java.lang.Long groupId_)` Removes a member group from a group
`void`	`removeMemberGroups(java.lang.Long[] memgroupIds_, java.lang.Long groupId_)` Removes a list of member groups from a group
`void`	`removeMemberUser(java.lang.String username_, java.lang.Long groupId_)` Deprecated. Use `removeMemberUsers(String[], Long)` and pass a single user in the array.
`void`	`removeMemberUsers(java.lang.String[] usernames_, java.lang.Long groupId_)` Removes a list of member users from a group
`void`	`removeMyselfFromGroup(java.lang.Long groupId_)` Removes oneself from the given group
`ResolvedEmailAddresses`	`resolveEmailAddress(LocalObject emailRecipient_)` Deprecated. Use `resolveEmailDestinations(LocalObject[], LocalObject[], LocalObject[])`
`ResolvedEmailAddresses`	`resolveEmailAddresses(LocalObject[] emailRecipients_)` Deprecated. Use `resolveEmailDestinations(LocalObject[], LocalObject[], LocalObject[])`
`ResolvedEmailAddresses[]`	`resolveEmailDestinations(LocalObject[] to_, LocalObject[] cc_, LocalObject[] bcc_)` Resolves three sets of email recipients, which form the email destination, into email addresses.
`void`	`setGlobalHomePage(java.lang.String url)` Sets home page for all users (default).
`void`	`setHomePageForUser(java.lang.String username_, java.lang.String url_)`
`void`	`setMyHomePage(java.lang.String url)` Sets home page for current user, overriding the system default for this user.
`java.lang.String`	`suggest(java.lang.String query, int maxItems, SuggestParam[] params, java.lang.Boolean groupResults)`
`java.lang.String`	`suggest(java.lang.String query, int maxItems, SuggestParam[] params, java.lang.Boolean groupResults, java.lang.Long[] allowList)`
`java.lang.String`	`suggestGroups(java.lang.String query_, int maxSuggestions_)` Deprecated. use `suggest(String, int, SuggestParam[], Boolean)` instead
`Suggestion[][]`	`suggestGroupsBulk(java.lang.String[] queries_, int maxSuggestionsPerQuery_)` Deprecated. use `suggest(String, int, SuggestParam[], Boolean)` instead
`java.lang.String`	`suggestUsersAndGroups(java.lang.String query_, int maxSuggestions_)` Deprecated. use `suggest(String, int, SuggestParam[], Boolean)` instead
`Suggestion[][]`	`suggestUsersAndGroupsBulk(java.lang.String[] queries_, int maxSuggestionsPerQuery_)` Deprecated. use `suggest(String, int, SuggestParam[], Boolean)` instead
`void`	`updateGroup(Group group_)` Updates a `Group`.
`void`	`updateGroups(Group[] groups_)` Updates multiple `Group` objects.
`void`	`updateRuleSetForGroup(RuleSet ruleSet_)` Updates the membership rule set for a `Group`.
`boolean`	`validateTypedValues(TypedValue[] typedValues)` Validates given TypedValues.

Methods inherited from interface com.appiancorp.services.ContextSensitiveSingletonService
configureContextSensitiveSingletonService

- Field Detail
  - USER_ROLE_SUPERADMIN
```
static final java.lang.Integer USER_ROLE_SUPERADMIN
```
  - USER_ROLE_CREATOR
```
static final java.lang.Integer USER_ROLE_CREATOR
```
  - USER_ROLE_ADMINISTRATOR
```
static final java.lang.Integer USER_ROLE_ADMINISTRATOR
```
  - USER_ROLE_VIEWER
```
static final java.lang.Integer USER_ROLE_VIEWER
```
  - USER_ROLE_MEMBER
```
static final java.lang.Integer USER_ROLE_MEMBER
```
  - USER_ROLE_NONMEMBER
```
static final java.lang.Integer USER_ROLE_NONMEMBER
```
  - RELATIONSHIP_TYPE_HEIRARCHY
```
static final java.lang.String RELATIONSHIP_TYPE_HEIRARCHY
```
    See Also:
    
    Constant Field Values
  - ACTION_GROUP_DELETE_GROUP
```
static final java.lang.Integer ACTION_GROUP_DELETE_GROUP
```
    Constant for whether the user can delete the group
  - ACTION_GROUP_EDIT_GROUP_ATTRIBUTES
```
static final java.lang.Integer ACTION_GROUP_EDIT_GROUP_ATTRIBUTES
```
    Constant for whether the user can edit group attributes
  - ACTION_GROUP_ADD_GROUP_MEMBERS
```
static final java.lang.Integer ACTION_GROUP_ADD_GROUP_MEMBERS
```
    Constant for whether the user can add members to the group
  - ACTION_GROUP_DELETE_GROUP_MEMBERS
```
static final java.lang.Integer ACTION_GROUP_DELETE_GROUP_MEMBERS
```
    Constant for whether the user can remove group members
  - ACTION_GROUP_ADD_GROUP_RULES
```
static final java.lang.Integer ACTION_GROUP_ADD_GROUP_RULES
```
    Constant for whether the user can add group membership rules
  - ACTION_GROUP_DELETE_GROUP_RULES
```
static final java.lang.Integer ACTION_GROUP_DELETE_GROUP_RULES
```
    Constant for whether the user can delete group membership rules
  - ACTION_GROUP_VIEW_GROUP_EXISTENCE
```
static final java.lang.Integer ACTION_GROUP_VIEW_GROUP_EXISTENCE
```
    Constant for whether the user can check the existence of the group
  - ACTION_GROUP_VIEW_GROUP_ATTRIBUTES
```
static final java.lang.Integer ACTION_GROUP_VIEW_GROUP_ATTRIBUTES
```
    Constant for whether the user can view the group attributes
  - ACTION_GROUP_VIEW_GROUP_MEMBERS
```
static final java.lang.Integer ACTION_GROUP_VIEW_GROUP_MEMBERS
```
    Constant for whether the user can view group members
  - ACTION_GROUP_VIEW_GROUP_RULES
```
static final java.lang.Integer ACTION_GROUP_VIEW_GROUP_RULES
```
    Constant for whether the user can view the membership rules of the group
  - ACTION_GROUP_ADD_SELF_TO_GROUP
```
static final java.lang.Integer ACTION_GROUP_ADD_SELF_TO_GROUP
```
    Constant for whether the user can add self to group
  - ACTION_GROUP_REMOVE_SELF_FROM_GROUP
```
static final java.lang.Integer ACTION_GROUP_REMOVE_SELF_FROM_GROUP
```
    Constant for whether the user can remove his/her membership from group
  - ACTION_GROUP_UPDATE_DELEGATED_ADMINISTRATION
```
static final java.lang.Integer ACTION_GROUP_UPDATE_DELEGATED_ADMINISTRATION
```
    Constant for whether the user can delegate group administration
  - ACTION_GROUP_USE_GROUP_AS_DELEGATED_PARENT
```
static final java.lang.Integer ACTION_GROUP_USE_GROUP_AS_DELEGATED_PARENT
```
    Constant for whether the group can be delegated to be a parent group for creation of new groups
  - GROUP_TYPE_CHANGE_SUCCESS
```
static final java.lang.Integer GROUP_TYPE_CHANGE_SUCCESS
```
    Constant for whether changing the group type of group was successful
  - GROUP_TYPE_CHANGE_NO_PRIVILEGE
```
static final java.lang.Integer GROUP_TYPE_CHANGE_NO_PRIVILEGE
```
    Constant for PrivilegeException where user cannot change group type of group
  - GROUP_TYPE_CHANGE_INVALID_GROUP
```
static final java.lang.Integer GROUP_TYPE_CHANGE_INVALID_GROUP
```
    Constant for InvalidGroupException where group Id is invalid.
  - GROUP_TYPE_CHANGE_INVALID_GROUPTYPE
```
static final java.lang.Integer GROUP_TYPE_CHANGE_INVALID_GROUPTYPE
```
    Constant for InvalidGroupTypeException when grouptype of group is invalid
  - createGroup$UPDATES
```
static final boolean createGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - createGroups$UPDATES
```
static final boolean createGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateGroup$UPDATES
```
static final boolean updateGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateGroups$UPDATES
```
static final boolean updateGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - deleteGroup$UPDATES
```
static final boolean deleteGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupName$UPDATES
```
static final boolean getGroupName$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupNames$UPDATES
```
static final boolean getGroupNames$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupNamesList$UPDATES
```
static final boolean getGroupNamesList$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupAttribute$UPDATES
```
static final boolean getGroupAttribute$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroup$UPDATES
```
static final boolean getGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroups$UPDATES
```
static final boolean getGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getCredentials$UPDATES
```
static final boolean getCredentials$UPDATES
```
    See Also:
    
    Constant Field Values
  - getCachedCredentials$UPDATES
```
static final boolean getCachedCredentials$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsOfType$UPDATES
```
static final boolean getGroupsOfType$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsOfTypePaging$UPDATES
```
static final boolean getGroupsOfTypePaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupTypeForGroup$UPDATES
```
static final boolean getGroupTypeForGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupIdsForUserByRole$UPDATES
```
static final boolean getGroupIdsForUserByRole$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsForUserByRole$UPDATES
```
static final boolean getGroupsForUserByRole$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsForUserByRolePaging$UPDATES
```
static final boolean getGroupsForUserByRolePaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsOfTypeForMemberUser$UPDATES
```
static final boolean getGroupsOfTypeForMemberUser$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberGroups$UPDATES
```
static final boolean getMemberGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberGroupsPaging$UPDATES
```
static final boolean getMemberGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUsers$UPDATES
```
static final boolean getMemberUsers$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUsersPaging$UPDATES
```
static final boolean getMemberUsersPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUserCount$UPDATES
```
static final boolean getMemberUserCount$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberGroupCount$UPDATES
```
static final boolean getMemberGroupCount$UPDATES
```
    See Also:
    
    Constant Field Values
  - addMemberGroup$UPDATES
```
static final boolean addMemberGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - addMemberGroups$UPDATES
```
static final boolean addMemberGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - addMemberUser$UPDATES
```
static final boolean addMemberUser$UPDATES
```
    See Also:
    
    Constant Field Values
  - addMemberUsers$UPDATES
```
static final boolean addMemberUsers$UPDATES
```
    See Also:
    
    Constant Field Values
  - addMyselfToGroup$UPDATES
```
static final boolean addMyselfToGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeMemberGroup$UPDATES
```
static final boolean removeMemberGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeMemberGroups$UPDATES
```
static final boolean removeMemberGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeMemberUser$UPDATES
```
static final boolean removeMemberUser$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeMemberUsers$UPDATES
```
static final boolean removeMemberUsers$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeMyselfFromGroup$UPDATES
```
static final boolean removeMyselfFromGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - findGroups$UPDATES
```
static final boolean findGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - isGroupDescendant$UPDATES
```
static final boolean isGroupDescendant$UPDATES
```
    See Also:
    
    Constant Field Values
  - isUserMember$UPDATES
```
static final boolean isUserMember$UPDATES
```
    See Also:
    
    Constant Field Values
  - getRootTrees$UPDATES
```
static final boolean getRootTrees$UPDATES
```
    See Also:
    
    Constant Field Values
  - getRootTreesSameTypeWithRoles$UPDATES
```
static final boolean getRootTreesSameTypeWithRoles$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTopLevelGroupsPaging$UPDATES
```
static final boolean getTopLevelGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTreeViewForGroup$UPDATES
```
static final boolean getTreeViewForGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTreeViewForGroupSameTypeWithRoles$UPDATES
```
static final boolean getTreeViewForGroupSameTypeWithRoles$UPDATES
```
    See Also:
    
    Constant Field Values
  - doesGroupExist$UPDATES
```
static final boolean doesGroupExist$UPDATES
```
    See Also:
    
    Constant Field Values
  - addGroupsToMyGroups$UPDATES
```
static final boolean addGroupsToMyGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeGroupsFromMyGroups$UPDATES
```
static final boolean removeGroupsFromMyGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMyGroupIds$UPDATES
```
static final boolean getMyGroupIds$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMyGroups$UPDATES
```
static final boolean getMyGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupSecurityTypes$UPDATES
```
static final boolean getGroupSecurityTypes$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupMembershipPolicyTypes$UPDATES
```
static final boolean getGroupMembershipPolicyTypes$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupMemberViewingPolicyTypes$UPDATES
```
static final boolean getGroupMemberViewingPolicyTypes$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAllAttributeTypes$UPDATES
```
static final boolean getAllAttributeTypes$UPDATES
```
    See Also:
    
    Constant Field Values
  - findNonMemberAncestorGroups$UPDATES
```
static final boolean findNonMemberAncestorGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - findAvailableParentGroups$UPDATES
```
static final boolean findAvailableParentGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - findAdminGroups$UPDATES
```
static final boolean findAdminGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getRuleSetForGroup$UPDATES
```
static final boolean getRuleSetForGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - updateRuleSetForGroup$UPDATES
```
static final boolean updateRuleSetForGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupSummaryForUser$UPDATES
```
static final boolean getGroupSummaryForUser$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupSummaryForUserPaging$UPDATES
```
static final boolean getGroupSummaryForUserPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - isGroupSystemGroup$UPDATES
```
static final boolean isGroupSystemGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsForUserByRoles$UPDATES
```
static final boolean getGroupsForUserByRoles$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsForUserByRolesPaging$UPDATES
```
static final boolean getGroupsForUserByRolesPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupActions$UPDATES
```
static final boolean getGroupActions$UPDATES
```
    See Also:
    
    Constant Field Values
  - canUseGroupName$UPDATES
```
static final boolean canUseGroupName$UPDATES
```
    See Also:
    
    Constant Field Values
  - getParentGroupsForDelegatedCreation$UPDATES
```
static final boolean getParentGroupsForDelegatedCreation$UPDATES
```
    See Also:
    
    Constant Field Values
  - getParentGroupsForDelegatedUpdate$UPDATES
```
static final boolean getParentGroupsForDelegatedUpdate$UPDATES
```
    See Also:
    
    Constant Field Values
  - getParentGroupsForDelegatedCreationPaging$UPDATES
```
static final boolean getParentGroupsForDelegatedCreationPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - findGroupsPaging$UPDATES
```
static final boolean findGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - findNonMemberAncestorGroupsPaging$UPDATES
```
static final boolean findNonMemberAncestorGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - findAvailableParentGroupsPaging$UPDATES
```
static final boolean findAvailableParentGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - findAdminGroupsPaging$UPDATES
```
static final boolean findAdminGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getApplicationName$UPDATES
```
static final boolean getApplicationName$UPDATES
```
    See Also:
    
    Constant Field Values
  - getWorkspace$UPDATES
```
static final boolean getWorkspace$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUsernames$UPDATES
```
static final boolean getMemberUsernames$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupIdsForUserByRoles$UPDATES
```
static final boolean getGroupIdsForUserByRoles$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGroupsList$UPDATES
```
static final boolean getGroupsList$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberGroupsDirect$UPDATES
```
static final boolean getMemberGroupsDirect$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberGroupsDirectPaging$UPDATES
```
static final boolean getMemberGroupsDirectPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUsersDirect$UPDATES
```
static final boolean getMemberUsersDirect$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUsersDirectPaging$UPDATES
```
static final boolean getMemberUsersDirectPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAdminUsersDirectPaging$UPDATES
```
static final boolean getAdminUsersDirectPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMemberUsernamesDirect$UPDATES
```
static final boolean getMemberUsernamesDirect$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTopLevelGroupsForHierarchy$UPDATES
```
static final boolean getTopLevelGroupsForHierarchy$UPDATES
```
    See Also:
    
    Constant Field Values
  - getTopLevelGroupsForHierarchyPaging$UPDATES
```
static final boolean getTopLevelGroupsForHierarchyPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - areUsersAddedByRule$UPDATES
```
static final boolean areUsersAddedByRule$UPDATES
```
    See Also:
    
    Constant Field Values
  - areGroupsAddedByRule$UPDATES
```
static final boolean areGroupsAddedByRule$UPDATES
```
    See Also:
    
    Constant Field Values
  - suggestGroups$UPDATES
```
static final boolean suggestGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - suggestUsersAndGroups$UPDATES
```
static final boolean suggestUsersAndGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - suggestGroupsBulk$UPDATES
```
static final boolean suggestGroupsBulk$UPDATES
```
    See Also:
    
    Constant Field Values
  - suggestUsersAndGroupsBulk$UPDATES
```
static final boolean suggestUsersAndGroupsBulk$UPDATES
```
    See Also:
    
    Constant Field Values
  - getUserDefaultApplication$UPDATES
```
static final boolean getUserDefaultApplication$UPDATES
```
    See Also:
    
    Constant Field Values
  - getSystemDefaultApplication$UPDATES
```
static final boolean getSystemDefaultApplication$UPDATES
```
    See Also:
    
    Constant Field Values
  - getMyHomePage$UPDATES
```
static final boolean getMyHomePage$UPDATES
```
    See Also:
    
    Constant Field Values
  - setGlobalHomePage$UPDATES
```
static final boolean setGlobalHomePage$UPDATES
```
    See Also:
    
    Constant Field Values
  - setHomePageForUser$UPDATES
```
static final boolean setHomePageForUser$UPDATES
```
    See Also:
    
    Constant Field Values
  - setMyHomePage$UPDATES
```
static final boolean setMyHomePage$UPDATES
```
    See Also:
    
    Constant Field Values
  - getGlobalHomePage$UPDATES
```
static final boolean getGlobalHomePage$UPDATES
```
    See Also:
    
    Constant Field Values
  - addGroupToFavorites$UPDATES
```
static final boolean addGroupToFavorites$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeGroupFromFavorites$UPDATES
```
static final boolean removeGroupFromFavorites$UPDATES
```
    See Also:
    
    Constant Field Values
  - getFavoriteGroups$UPDATES
```
static final boolean getFavoriteGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAdminUsers$UPDATES
```
static final boolean addAdminUsers$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeAdminUsers$UPDATES
```
static final boolean removeAdminUsers$UPDATES
```
    See Also:
    
    Constant Field Values
  - addAdminGroups$UPDATES
```
static final boolean addAdminGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - removeAdminGroups$UPDATES
```
static final boolean removeAdminGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAdminGroupsPaging$UPDATES
```
static final boolean getAdminGroupsPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAdminUsersPaging$UPDATES
```
static final boolean getAdminUsersPaging$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAdminUserCount$UPDATES
```
static final boolean getAdminUserCount$UPDATES
```
    See Also:
    
    Constant Field Values
  - getAdminGroupCount$UPDATES
```
static final boolean getAdminGroupCount$UPDATES
```
    See Also:
    
    Constant Field Values
  - isMemberOfGroups$UPDATES
```
static final boolean isMemberOfGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - isUserMemberOfGroups$UPDATES
```
static final boolean isUserMemberOfGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - areUsersMembersOfGroups$UPDATES
```
static final boolean areUsersMembersOfGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - getDirectMemberGroupIds$UPDATES
```
static final boolean getDirectMemberGroupIds$UPDATES
```
    See Also:
    
    Constant Field Values
  - getDirectMemberUsernames$UPDATES
```
static final boolean getDirectMemberUsernames$UPDATES
```
    See Also:
    
    Constant Field Values
  - getDirectAdminGroupIds$UPDATES
```
static final boolean getDirectAdminGroupIds$UPDATES
```
    See Also:
    
    Constant Field Values
  - getDirectAdminUsernames$UPDATES
```
static final boolean getDirectAdminUsernames$UPDATES
```
    See Also:
    
    Constant Field Values
  - suggest$UPDATES
```
static final boolean suggest$UPDATES
```
    See Also:
    
    Constant Field Values
  - resolveEmailAddress$UPDATES
```
static final boolean resolveEmailAddress$UPDATES
```
    See Also:
    
    Constant Field Values
  - resolveEmailAddresses$UPDATES
```
static final boolean resolveEmailAddresses$UPDATES
```
    See Also:
    
    Constant Field Values
  - resolveEmailDestinations$UPDATES
```
static final boolean resolveEmailDestinations$UPDATES
```
    See Also:
    
    Constant Field Values
  - changeGroupTypeOfGroup$UPDATES
```
static final boolean changeGroupTypeOfGroup$UPDATES
```
    See Also:
    
    Constant Field Values
  - changeGroupTypesOfGroups$UPDATES
```
static final boolean changeGroupTypesOfGroups$UPDATES
```
    See Also:
    
    Constant Field Values
  - validateTypedValues$UPDATES
```
static final boolean validateTypedValues$UPDATES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - createGroup
```
java.lang.Long createGroup(Group group_)
                    throws DuplicateNameException,
                           UnsupportedAttributeTypeException,
                           InvalidAttributeException,
                           InvalidGroupTypeException,
                           InvalidParentException,
                           InvalidNameException,
                           InvalidCreatorException,
                           InvalidSecurityMapException,
                           InvalidMemberPolicyException,
                           InvalidViewingPolicyException,
                           InvalidAttributeValueException,
                           PrivilegeException,
                           DuplicateUuidException
```
    Create a new group. groupName must be unique for public and team groups. If the Group is of a group type with attributes, you must pass the correct Attribute list with the correct name and type for each Attribute with the Group. Should be used in conjunction with GroupTypeService.getGroupTypeAttributes(Long groupTypeId) in order to properly fill the setAttributes(Attribute[]) field of the Group passed in. If the Attribute[] does not match the group type's attributes, then an InvalidAttributeException will be thrown.
    Note that when a Group specifies a parent, it automatically becomes a member Group of its parent.
    The Group fields required for creation are: groupName, groupTypeId, creatorName, securityMapId. If groupTypeId points to a GroupType with attributes, then all the attributes fields are required.
    In order to minimize possible breaks with the user interface, it is HIGHLY recommended that the groupName in the Group object be validated for illegal characters (only allow alphanumeric symbols and underscores).
    Note: Personal Groups must have CLOSED membership policy and HIGH member viewing policy and Team Groups cannot have an AUTOMATIC membership policy; otherwise InvalidMemberPolicyException or InvalidViewingPolicyException will be thrown
    
    Parameters:
    
    group_ - the Group to create
    
    Returns:
    
    the id of the Group created
    
    Throws:
    
    DuplicateNameException - Thrown when the group is a public or team group and its name is not unique.
    
    UnsupportedAttributeTypeException - Thrown when trying to create or update an attribute type that is not supported by the GroupService.
    
    InvalidAttributeException - Thrown when trying to get, update, or delete an attribute for a GroupType that does not exist.
    
    InvalidGroupTypeException - This exception may be thrown by service methods detecting that a given GroupType does not exist.
    
    InvalidParentException - Thrown when user passes in invalid Group as parent.
    
    InvalidNameException - thrown when the groupname is null or empty.
    
    InvalidCreatorException - Thrown when a invalid user is passed as creator of Group.
    
    InvalidSecurityMapException - thrown if the securitymapId field passed in Group object is invalid.
    
    InvalidMemberPolicyException - Thrown when membership policy is invalid or not applicable to the Group.
    
    InvalidViewingPolicyException - Thrown when viewing policy is invalid or not applicable to the Group.
    
    InvalidAttributeValueException - Thrown when incorrect attributes values are passed.
    
    PrivilegeException - Thrown when the user does not have privileges to create a Group.
    
    DuplicateUuidException - Thrown when the UUID passed in already exists in the system.
  - createGroups
```
java.lang.Long[] createGroups(Group[] groups_)
                       throws UnsupportedAttributeTypeException,
                              InvalidGroupTypeException,
                              InvalidParentException,
                              InvalidNameException,
                              InvalidCreatorException,
                              InvalidSecurityMapException,
                              InvalidMemberPolicyException,
                              InvalidViewingPolicyException,
                              PrivilegeException,
                              InvalidAttributeException,
                              InvalidAttributeValueException,
                              DuplicateUuidException
```
    Create new groups. groupName must be unique for public and team groups. It does not support creating groups with group types having attributes. If groups with group type having attributes are passed, it simply returns null ids in the corresponding entries for those groups in the return list, as no groups are created for these cases.
    Note that when a Group specifies a parent, it automatically becomes a member Group of its parent.
    The Group fields required for creation are: groupName, groupTypeId, creatorName, securityMapId.
    In order to minimize possible breaks with the user interface, it is HIGHLY recommended that groupName in the Group object be validated for illegal characters (only allow alphanumeric symbols and underscores).
    Note: Personal Groups must have CLOSED membership policy and HIGH member viewing policy and Team Groups cannot have AUTOMATIC membership policy; otherwise InvalidMemberPolicyException or InvalidViewingPolicyException will be thrown
    
    Parameters:
    
    groups_ - the groups to create
    
    Returns:
    
    the ids of the groups created; null entries for the corresponding groups with group type having attributes.
    
    Throws:
    
    UnsupportedAttributeTypeException - Thrown when trying to create or update an attribute type that is not supported by the Personalization service.
    
    InvalidGroupTypeException - This exception may be thrown by service methods detecting that a given GroupType does not exist.
    
    InvalidParentException - Thrown when user passes in invalid Group as parent.
    
    InvalidNameException - thrown when the groupname is null or empty.
    
    InvalidCreatorException - Thrown when a invalid user is passed as creator of Group.
    
    InvalidSecurityMapException - thrown if the securitymapId field passed in Group object is invalid.
    
    InvalidMemberPolicyException - Thrown when membership policy is invalid or not applicable to the Group.
    
    InvalidViewingPolicyException - Thrown when viewing policy is invalid or not applicable to the Group.
    
    PrivilegeException - Thrown when the user does not have privileges to create one or more of the Groups.
    
    InvalidAttributeException - Never thrown. Is only declared for backwards compatibility.
    
    InvalidAttributeValueException - Never thrown. Is only declared for backwards compatibility.
    
    DuplicateUuidException - Thrown when the UUID of any of the groups already exists or if the same UUID is passed in for several groups
  - updateGroup
```
void updateGroup(Group group_)
          throws InvalidGroupException,
                 DuplicateNameException,
                 RecursiveRelationshipException,
                 InvalidParentException,
                 UnsupportedAttributeTypeException,
                 InvalidAttributeException,
                 InvalidGroupTypeException,
                 InvalidSecurityMapException,
                 InvalidMemberPolicyException,
                 InvalidViewingPolicyException,
                 InvalidAttributeValueException,
                 PrivilegeException
```
    Updates a Group. groupName must be unique for public and team groups. If the group is of a group type with attributes, you must pass the correct Attribute list with the correct name and type for each Attribute with the Group. Should be used in conjunction with GroupTypeService.getGroupTypeAttributes(Long groupTypeId) in order to properly fill the setAttributes(Attribute[]) field of the Group passed in. If the Attribute[] does not match the Group Type's attributes, then an InvalidAttributeException will be thrown.
    The following fields are set when a Group is created and cannot be changed using this method: id and groupTypeId.
    Only the following fields can be changed: groupName, description, parentId, securityMapId, attributes, memberPolicyId, viewingPolicyId, delegatedCreation.
    If the group does not have a parent then parentId should be set to -1.
    Note that when a group specifies a parent, it automatically becomes a member group of its parent.
    In order to minimize possible breaks with the user interface, it is HIGHLY recommended that the groupName be validated for illegal characters (only allow alphanumeric symbols and underscores).
    
    Parameters:
    
    group_ - the group to update. Group id must be populated as well as groupName, groupTypeId, creatorName, securityMapId, viewingPolicyId, memberPolicyId, and parentId. If groupTypeId points to a GroupType with attributes, then all the attributes fields are required.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id or group name is passed into a service method.
    
    DuplicateNameException - This exception may be thrown by service methods detecting that a given name is not unique.
    
    RecursiveRelationshipException - Thrown when a relationship is trying to be created that will result in a recursive loop (for instance, if the group is being updated to be a child of itself).
    
    InvalidParentException - Thrown when user passes in invalid group as parent.
    
    UnsupportedAttributeTypeException - Thrown when trying to create or update an attribute type that is not supported by the Personalization service.
    
    InvalidAttributeException - Thrown when trying to get, update, or delete an attribute for a group type that does not exist.
    
    InvalidGroupTypeException - This exception may be thrown by service methods detecting that a given group type does not exist.
    
    InvalidSecurityMapException - thrown if the securitymap Id field passed in Group object is invalid.
    
    InvalidMemberPolicyException - Thrown when membership policy is invalid or not applicable to the group.
    
    InvalidViewingPolicyException - Thrown when viewing policy is invalid or not applicable to the group.
    
    InvalidAttributeValueException - Thrown when incorrect attributes values are passed.
    
    PrivilegeException - Thrown when the user does not have privileges to update the group.
  - updateGroups
```
void updateGroups(Group[] groups_)
           throws InvalidGroupException,
                  RecursiveRelationshipException,
                  InvalidParentException,
                  UnsupportedAttributeTypeException,
                  InvalidAttributeException,
                  InvalidGroupTypeException,
                  InvalidSecurityMapException,
                  InvalidMemberPolicyException,
                  InvalidViewingPolicyException,
                  InvalidAttributeValueException,
                  PrivilegeException
```
    Updates multiple Group objects. groupName must be unique for public and team groups. If the group is of a group type with attributes, you must pass the correct Attribute list with the correct name and type for each Attribute with the group. Should be used in conjunction with GroupTypeService.getGroupTypeAttributes(Long groupTypeId) in order to properly fill the setAttributes(Attribute[]) field of the Group passed in. If the Attribute[] does not match the Group Type's attributes, then an InvalidAttributeException will be thrown.
    The following fields are set when a Group is created and cannot be changed using this method: id and groupTypeId.
    Only the following fields can be changed: groupName, description, parentId, securityMapId, attributes, memberPolicyId, viewingPolicyId, delegatedCreation.
    If the group does not have a parent then parentId should be set to -1.
    Note that when a group specifies a parent, it automatically becomes a member group of its parent.
    In order to minimize possible breaks with the user interface, it is HIGHLY recommended that the groupName be validated for illegal characters (only allow alphanumeric symbols and underscores).
    
    Parameters:
    
    groups_ - the groups to update. Group id must be populated as well as groupName, groupTypeId, creatorName, securityMapId, viewingPolicyId, memberPolicyId, and parentId. If groupTypeId points to a GroupType with attributes, then all the attributes fields are required.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id or group name is passed into a service method.
    
    RecursiveRelationshipException - Thrown when a relationship is trying to be created that will result in a recursive loop (for instance, if the group is being updated to be a child of itself).
    
    InvalidParentException - Thrown when user passes in invalid group as parent.
    
    UnsupportedAttributeTypeException - Thrown when trying to create or update an attribute type that is not supported by the Personalization service.
    
    InvalidAttributeException - Thrown when trying to get, update, or delete an attribute for a group type that does not exist.
    
    InvalidGroupTypeException - This exception may be thrown by service methods detecting that a given group type does not exist.
    
    InvalidSecurityMapException - thrown if the securitymap Id field passed in Group object is invalid.
    
    InvalidMemberPolicyException - Thrown when membership policy is invalid or not applicable to the group.
    
    InvalidViewingPolicyException - Thrown when viewing policy is invalid or not applicable to the group.
    
    InvalidAttributeValueException - Thrown when incorrect attributes values are passed.
    
    PrivilegeException - Thrown when the user does not have privileges to update one or more of the groups.
  - deleteGroup
```
void deleteGroup(java.lang.Long groupId_)
          throws InvalidGroupException,
                 SystemGroupException,
                 GroupIsAttributeException
```
    Deletes a single group. NOTE: To register in the other (non-personalization) portal applications that a group has been deleted, this call must be followed by a call to AdministrationService.notifyGroupDeletion(java.lang.Long)
    
    Parameters:
    
    groupId_ - the id of the group to delete
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    SystemGroupException - Thrown when trying to delete a group that is core to the Personalization service such as Portal Administrators or Collaboration Administrators.
    
    GroupIsAttributeException - Thrown when trying to delete a group that is being used as an attribute for another group.
  - getGroupName
```
java.lang.String getGroupName(java.lang.Long groupId_)
                       throws InvalidGroupException
```
    Gets a group name for a given group id.
    
    Parameters:
    
    groupId_ - the id of the group
    
    Returns:
    
    the name of the group
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - getGroupNames
```
java.lang.String[] getGroupNames(java.lang.Long[] groupIds_)
                          throws InvalidGroupException
```
    Gets a list of group names for a given list of group ids.
    
    Parameters:
    
    groupIds_ - the ids of groups
    
    Returns:
    
    the matching list of group names
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - getGroupNamesList
```
ResultList getGroupNamesList(java.lang.Long[] groupIds_)
```
    Gets a list of group names for a given list of group ids.
    
    Parameters:
    
    groupIds_ - the ids of groups
    
    Returns:
    
    ResultList containing group names and result codes. Each result code will be either CODE_VALID (for valid group ids) or CODE_INVALID (for invalid group ids) from ResultList. The results will only contain the names of the valid groups and thus may have a length less than the number of group ids passed in.
  - getGroupAttribute
```
Attribute getGroupAttribute(java.lang.Long groupId_,
                            java.lang.String attributeName_)
                     throws InvalidGroupException
```
    Gets a group attribute for a given group id.
    
    Parameters:
    
    groupId_ - the id of the group
    
    attributeName_ - the name of the desired attribute
    
    Returns:
    
    the requested Attribute, or null if the attribute does not exists
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    java.lang.NullPointerException - if the passed group id and/or the attribute name are null.
  - getGroup
```
Group getGroup(java.lang.Long groupId_)
        throws InvalidGroupException,
               PrivilegeException
```
    Get a group by id.
    
    Parameters:
    
    groupId_ - the group id
    
    Returns:
    
    the requested group
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the current User does not have rights to view the group
  - getGroups
```
Group[] getGroups(java.lang.Long[] groupIds_)
           throws InvalidGroupException,
                  PrivilegeException
```
    Gets a list of groups for a given list of group ids.
    
    Parameters:
    
    groupIds_ - the group ids
    
    Returns:
    
    the list of groups
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the current user does not have rights to view the one or more of groups.
  - getCredentials
```
Credentials getCredentials()
                    throws InvalidUserException
```
    Returns a Credentials bean directly from the back-end, containing the group membership relations for the user in this Service Context. This is a System-level call not meant to be used externally.
    
    Returns:
    
    Credentials bean with the user's membership data.
    
    Throws:
    
    InvalidUserException - if the credentials for that user cannot be retrieved.
  - getCachedCredentials
```
Credentials getCachedCredentials()
                          throws InvalidUserException
```
    Returns the cached Credentials bean containing the group membership relations for the user in this Service Context. If the user does not have an entry in the cache, then the Credentials are retrieved from the back-end. Also note that changes made directly on this bean won't be persisted in the system. The Credentials bean is for practical purposed read only. This is a System-level call not meant to be used externally.
    
    Returns:
    
    Credentials bean with the user's membership data.
    
    Throws:
    
    InvalidUserException - if the credentials for that user cannot be retrieved.
  - getGroupsOfType
```
@Deprecated
Group[] getGroupsOfType(java.lang.Long groupTypeId_)
                             throws InvalidGroupTypeException
```
    Deprecated. use getGroupsOfTypePaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Gets a list of groups for a given group type.
    
    Parameters:
    
    groupTypeId_ - the group type id
    
    Returns:
    
    the groups
    
    Throws:
    
    ServiceException - if any system-level error occurs
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
  - getGroupsOfTypePaging
```
ResultPage getGroupsOfTypePaging(java.lang.Long groupTypeId_,
                                 int startIndex_,
                                 int batchSize_,
                                 java.lang.Integer sortProperty_,
                                 java.lang.Integer sortOrder_)
                          throws InvalidGroupTypeException
```
    Gets a ResultPage containing a list of groups for a given group type
    
    Parameters:
    
    groupTypeId_ - the group type id
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of Group objects
    
    Throws:
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
  - getGroupTypeForGroup
```
java.lang.Long[] getGroupTypeForGroup(java.lang.Long[] groupIds_)
                               throws InvalidGroupException
```
    Gets group types for a list of groups.
    
    Parameters:
    
    groupIds_ - the group ids
    
    Returns:
    
    group type ids. should have always have a type, even if just default.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group ids are passed into a service method.
  - getGroupIdsForUserByRole
```
java.lang.Long[] getGroupIdsForUserByRole(java.lang.String username_,
                                          java.lang.Integer role_)
                                   throws InvalidUserException,
                                          UnsupportedRoleException,
                                          PrivilegeException
```
    Gets a list of group ids for which a given user has a given role. Supported roles are:
    - USER_ROLE_CREATOR
    - USER_ROLE_ADMINISTRATOR - Note that when using this role, if the user is a System Administrator, only system groups will be returned.
    - USER_ROLE_MEMBER
    Parameters:
    
    username_ - the unique key for the user
    
    role_ - the role id
    
    Returns:
    
    the list of group ids
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    UnsupportedRoleException - This exception is thrown whenever an invalid role id is passed into a service method.
    
    PrivilegeException
  - getGroupsForUserByRole
```
Group[] getGroupsForUserByRole(java.lang.String username_,
                               java.lang.Integer role_)
                        throws InvalidUserException,
                               UnsupportedRoleException,
                               PrivilegeException
```
    Gets a list of groups for which a given user has a given role. Supported roles are:
    - USER_ROLE_CREATOR
    - USER_ROLE_ADMINISTRATOR - Note that when using this role, if the user is a System Administrator, only system groups will be returned.
    - USER_ROLE_MEMBER
    Parameters:
    
    username_ - the user
    
    role_ - the role id
    
    Returns:
    
    the list of groups
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    UnsupportedRoleException - This exception is thrown whenever an invalid role id is passed into a service method.
    
    PrivilegeException
  - getGroupsForUserByRolePaging
```
ResultPage getGroupsForUserByRolePaging(java.lang.String username_,
                                        java.lang.Integer role_,
                                        int startIndex_,
                                        int batchSize_,
                                        java.lang.Integer sortProperty_,
                                        java.lang.Integer sortOrder_)
                                 throws InvalidUserException,
                                        UnsupportedRoleException,
                                        PrivilegeException
```
    Gets a ResultPage containing list of groups for which a given user has a given role. Supported roles are:
    Parameters:
    
    username_ - the user
    
    role_ - the role
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list group objects
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    UnsupportedRoleException - thrown when an invalid role id is passed.
    
    PrivilegeException
  - getGroupsOfTypeForMemberUser
```
@Deprecated
Group[] getGroupsOfTypeForMemberUser(java.lang.Long[] groupTypeIds_,
                                                 java.lang.String username_)
                                          throws InvalidGroupTypeException,
                                                 InvalidUserException
```
    Deprecated. Use getGroupsForUserByRolePaging(String, Integer, int, int, Integer, Integer) and extract groups of the desired types from the results.
    
    Gets a list of groups, for a given list of group types, of which a given user is a memeber
    
    Parameters:
    
    groupTypeIds_ - the group type ids
    
    username_ - the username of the user to get groups for
    
    Returns:
    
    the list of groups
    
    Throws:
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
  - getMemberGroups
```
Group[] getMemberGroups(java.lang.Long groupId_)
                 throws InvalidGroupException,
                        PrivilegeException
```
    Gets a list of members groups of a group
    
    Parameters:
    
    groupId_ - the group for which to get members
    
    Returns:
    
    the member groups. Note: If the user can see the group but cannot view members of group, the returned array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user is not the administrator of the group and the group is not public.
  - getMemberGroupsPaging
```
ResultPage getMemberGroupsPaging(java.lang.Long groupId_,
                                 int startIndex_,
                                 int batchSize_,
                                 java.lang.Integer sortProperty_,
                                 java.lang.Integer sortOrder_)
                          throws InvalidGroupException,
                                 PrivilegeException
```
    Gets a ResultPage containing a list of group members of a group
    
    Parameters:
    
    groupId_ - the group for which to get group members
    
    startIndex_ - the index of the first Group that will be returned
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the Group objects will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing Group objects, representing the member groups. Note: If the user can see the group but cannot view members of group, the results array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user is not the administrator of the group and the group is not public.
  - getMemberUsers
```
User[] getMemberUsers(java.lang.Long groupId_)
               throws InvalidGroupException,
                      PrivilegeException
```
    Gets a list of member users of the specified group
    
    Parameters:
    
    groupId_ - the group to get members from.
    
    Returns:
    
    the member users. Note: If the current user can see the group but cannot view members of group, the returned array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user is not the administrator of the group and the group is not public.
  - getMemberUsersPaging
```
ResultPage getMemberUsersPaging(java.lang.Long groupId_,
                                int startIndex_,
                                int batchSize_,
                                java.lang.Integer sortProperty_,
                                java.lang.Integer sortOrder_)
                         throws InvalidGroupException,
                                PrivilegeException
```
    Gets a ResultPage containing a list of member users of the specified group
    
    Parameters:
    
    groupId_ - the group for which to get members
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in User
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of User objects. Note: If the current user can see the group but cannot view members of group, the results array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user is not the administrator of the group and the group is not public.
  - getMemberUsers
```
User[] getMemberUsers(java.lang.Long[] groupIds_)
               throws InvalidGroupException,
                      PrivilegeException
```
    Gets a list of distinct users that are members of any of the specified groups.
    
    Parameters:
    
    groupIds_ - the groups to get members from.
    
    Returns:
    
    the member users. Note: If the current user can see a group but cannot view members of the group, the returned list will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method. *
    
    PrivilegeException - if the user is not the administrator of one of the groups and the group is not public.
  - getMemberUserCount
```
int getMemberUserCount(java.lang.Long groupId_)
                throws InvalidGroupException,
                       PrivilegeException
```
    Gets a count of distinct users that are members of the specified group.
    
    Parameters:
    
    groupId_ - the group whose user members are to be counted
    
    Returns:
    
    the count of member users. Note: If the user can see the group but cannot view members of group, the returned member count will be 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user does not have sufficient privileges
  - getMemberGroupCount
```
int getMemberGroupCount(java.lang.Long groupId_)
                 throws InvalidGroupException,
                        PrivilegeException
```
    Gets the number of distinct groups {that are members of the specified group.
    
    Parameters:
    
    groupId_ - the group to count group members of.
    
    Returns:
    
    the count. Note: If the current user can see the group but cannot view members of group, the returned member count will be 0.
    
    Throws:
    
    ServiceException - if any system-level error occurs
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user does not have sufficient privileges
  - addMemberGroup
```
void addMemberGroup(java.lang.Long memgroupId_,
                    java.lang.Long groupId_)
             throws InvalidGroupException,
                    RecursiveRelationshipException,
                    PrivilegeException
```
    Adds a member group to a group.
    
    Parameters:
    
    memgroupId_ - id of the group to add
    
    groupId_ - the group to add the member to
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    RecursiveRelationshipException - Thrown when a relationship is trying to be created that will result in a recursive loop (eg if the member group ID and the group ID refer to the same group).
    
    PrivilegeException - Thrown when the user does not have privileges to add the group as a member
  - addMemberGroups
```
void addMemberGroups(java.lang.Long[] memgroupIds_,
                     java.lang.Long groupId_)
              throws InvalidGroupException,
                     RecursiveRelationshipException,
                     PrivilegeException
```
    Adds member groups to a group
    
    Parameters:
    
    memgroupIds_ - ids of the groups to add
    
    groupId_ - the group to add members to
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    RecursiveRelationshipException - Thrown when a relationship is trying to be created that will result in a recursive loop (eg if a member group ID and the group ID refer to the same group)..
    
    PrivilegeException - Thrown when the user does not have privileges to add one or more of the groups as members
  - addMemberUser
```
void addMemberUser(java.lang.String username_,
                   java.lang.Long groupId_)
            throws InvalidUserException,
                   InvalidGroupException,
                   PrivilegeException
```
    Adds a member user to a group .
    
    Parameters:
    
    username_ - username of the user to add to the group
    
    groupId_ - the group to add the member to
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to add the user as a member
  - addMemberUsers
```
void addMemberUsers(java.lang.String[] usernames_,
                    java.lang.Long groupId_)
             throws InvalidUserException,
                    InvalidGroupException,
                    PrivilegeException
```
    Adds member users to a group
    
    Parameters:
    
    usernames_ - the usernames of the users to add
    
    groupId_ - the group to add members to
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to add one or more the users as members
  - addMyselfToGroup
```
void addMyselfToGroup(java.lang.Long groupId_)
               throws InvalidGroupException,
                      PrivilegeException
```
    Adds oneself to the given group
    
    Parameters:
    
    groupId_ - the id of the group which the current user wishes to join
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to add himself or herself as a member of the group
  - removeMemberGroup
```
void removeMemberGroup(java.lang.Long memgroupId_,
                       java.lang.Long groupId_)
                throws InvalidGroupException,
                       PrivilegeException
```
    Removes a member group from a group
    
    Parameters:
    
    memgroupId_ - id of the member to remove
    
    groupId_ - id of the group to remove member from
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to remove the group's membership
  - removeMemberGroups
```
void removeMemberGroups(java.lang.Long[] memgroupIds_,
                        java.lang.Long groupId_)
                 throws InvalidGroupException,
                        PrivilegeException
```
    Removes a list of member groups from a group
    
    Parameters:
    
    memgroupIds_ - the ids of members to remove
    
    groupId_ - id of the group to remove member from
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to remove any of the group's memberships
  - removeMemberUser
```
@Deprecated
void removeMemberUser(java.lang.String username_,
                                  java.lang.Long groupId_)
                           throws InvalidUserException,
                                  InvalidGroupException,
                                  PrivilegeException
```
    Deprecated. Use removeMemberUsers(String[], Long) and pass a single user in the array.
    
    Removes a member user from a group
    
    Parameters:
    
    username_ - the username of the member to remove
    
    groupId_ - the id of the group to remove the member from
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to remove the user's membership
  - removeMemberUsers
```
void removeMemberUsers(java.lang.String[] usernames_,
                       java.lang.Long groupId_)
                throws InvalidUserException,
                       InvalidGroupException,
                       PrivilegeException
```
    Removes a list of member users from a group
    
    Parameters:
    
    usernames_ - the usernames of the members to remove
    
    groupId_ - the id of the group to remove members from
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - Thrown when the user does not have privileges to remove any of the users' membership
  - removeMyselfFromGroup
```
void removeMyselfFromGroup(java.lang.Long groupId_)
                    throws InvalidGroupException
```
    Removes oneself from the given group
    
    Parameters:
    
    groupId_ - the id of the group from which one wants to remove oneself
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - findGroups
```
@Deprecated
Group[] findGroups(GroupSearch groupSearch_,
                               boolean caseSensitive_)
                        throws UnsupportedOperatorException
```
    Deprecated. use findGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Finds groups based on criteria submitted in the GroupSearch The supported search operators are specified in GroupSearch for a group See getOperatorsForAttributeType() in GroupTypeService to obtain a list of possible operators Operator for a given data type. The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search bean
    
    caseSensitive_ - false for case insensitive, true for case sensitive.
    
    Returns:
    
    a list of groups that matched the search criteria
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - isGroupDescendant
```
boolean isGroupDescendant(java.lang.Long groupId_,
                          java.lang.Long parentGroupId_)
                   throws InvalidGroupException
```
    Checks if a group is a descendant of another group (by parent-child relationship).
    
    Parameters:
    
    groupId_ - the id of the group
    
    parentGroupId_ - id of the group for which to check the descendants
    
    Returns:
    
    true if given group was descendant of passed in parent group, else false.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - isUserMember
```
boolean isUserMember(java.lang.String username_,
                     java.lang.Long groupId_)
              throws InvalidUserException,
                     InvalidGroupException,
                     PrivilegeException
```
    Checks if a user is a member of a group
    
    Parameters:
    
    username_ - the username
    
    groupId_ - the group id to check
    
    Returns:
    
    true if passed in user is member of given group, else false
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever a non-empty invalid username is passed into the service method.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into the service method.
    
    java.lang.NullPointerException - If the passed username is either null or empty.
    
    PrivilegeException
  - isUserMember
```
boolean isUserMember(java.lang.String[] username_,
                     java.lang.Long groupId_)
              throws InvalidUserException,
                     InvalidGroupException,
                     PrivilegeException
```
    Checks multiple potential usernames to determine if a user is a member of a group
    
    Parameters:
    
    username_ - the usernames
    
    groupId_ - the group id to check
    
    Returns:
    
    true if passed in user is member of given group, else false
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever all non-empty/non-null usernames passed into the service method are invalid.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into the service method.
    
    java.lang.NullPointerException - If all passed usernames are either null or empty.
    
    PrivilegeException
  - isUserMember
```
boolean isUserMember(java.lang.String username_,
                     java.lang.String groupUuid_)
              throws InvalidUserException,
                     InvalidGroupException,
                     PrivilegeException
```
    Checks if a user is a member of a group
    
    Parameters:
    
    username_ - the username
    
    groupUuid_ - the group UUID to check
    
    Returns:
    
    true if passed in user is member of given group, else false
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever all non-empty/non-null usernames passed into the service method are invalid.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into the service method.
    
    java.lang.NullPointerException - If all passed usernames are either null or empty.
    
    PrivilegeException
  - isUserMember
```
boolean isUserMember(java.lang.String[] username_,
                     java.lang.String groupUuid_)
              throws InvalidUserException,
                     InvalidGroupException,
                     PrivilegeException
```
    Checks multiple potential usernames to determine if a user is a member of a group
    
    Parameters:
    
    username_ - the usernames
    
    groupUuid_ - the group UUID to check
    
    Returns:
    
    true if passed in user is member of given group, else false
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever all non-empty/non-null usernames passed into the service method are invalid.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into the service method.
    
    java.lang.NullPointerException - If all passed usernames are either null or empty.
    
    PrivilegeException
  - getRootTrees
```
Tree[] getRootTrees(java.lang.Long groupTypeId_,
                    java.lang.String relationshipType_,
                    boolean singleGroupType_,
                    int descendentDepth_)
             throws InvalidGroupTypeException
```
    Get a set of groups structured into one or more trees. Each node in the tree will represent a group. The id, name of the node will be id and groupName of the group, and data field of the node will be the group itself.
    
    Parameters:
    
    groupTypeId_ - The group type of the root node groups.
    
    relationshipType_ - The relationship connecting the groups. Currently, the only permissible value is RELATIONSHIP_TYPE_HEIRARCHY.
    
    singleGroupType_ - true if only groups of the same group type as the root should be returned; false if all groups, regardless of group type, should be returned.
    
    descendentDepth_ - The number of levels below the root that should be returned.
    
    Returns:
    
    The tree representing the root level groups
    
    Throws:
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
  - getRootTreesSameTypeWithRoles
```
Tree[] getRootTreesSameTypeWithRoles(java.lang.Long groupTypeId_,
                                     java.lang.Integer[] roleTypes_,
                                     int descendantDepth_)
                              throws InvalidGroupTypeException
```
    Get a set of groups Group structured into one or more trees Tree. Only those groups are returned for which the user's privilege matches the specified roles
    
    Parameters:
    
    groupTypeId_ - The group type GroupType of the root node groups.
    
    roleTypes_ - array of roles which should match user's privilege
    
    descendantDepth_ - The number of levels below the root that should be returned.
    
    Returns:
    
    The tree representing the root level groups
    
    Throws:
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
  - getTopLevelGroupsPaging
```
ResultPage getTopLevelGroupsPaging(java.lang.Long groupTypeId_,
                                   java.lang.String relationshipType_,
                                   boolean singleGroupType_,
                                   int startIndex_,
                                   int batchSize_,
                                   java.lang.Integer sortProperty_,
                                   java.lang.Integer sortOrder_)
                            throws InvalidGroupTypeException
```
    Get a ResultPage containing a list of groups structured into one or more trees in the result field. Each node in the tree will represent a group. The id, name of the node will be id and groupName of the group, and data field of the node will be the group itself.
    
    Parameters:
    
    groupTypeId_ - The group type of the root node groups.
    
    relationshipType_ - The relationship connecting the groups. Currently, the only permissible value is RELATIONSHIP_TYPE_HEIRARCHY.
    
    singleGroupType_ - true if only groups of the same group type as the root should be returned; false if all groups, regardless of group type, should be returned.
    
    startIndex_ - the index of the first Group that will be returned
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the Group objects will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing batchSize_ Group objects.
    
    Throws:
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
  - getRootTrees
```
Tree[] getRootTrees(java.lang.Long groupTypeId_,
                    java.lang.String relationshipType_,
                    java.lang.Long[] groupTypeIds_,
                    int descendentDepth_)
             throws InvalidGroupTypeException
```
    Get a set of groups structured into one or more trees. * Each node in the tree will represent a group. The id, name of the node will be id and groupName of the group, and data field of the node will be the group itself.
    
    Parameters:
    
    groupTypeId_ - The group type of the root node groups.
    
    relationshipType_ - The relationship connecting the groups. Currently, the only permissible value is RELATIONSHIP_TYPE_HEIRARCHY.
    
    groupTypeIds_ - Only groups of these group types should be returned in the tree.
    
    descendentDepth_ - The number of levels below the root that should be returned.
    
    Returns:
    
    The Trees
    
    Throws:
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
  - getTreeViewForGroup
```
TreePivot getTreeViewForGroup(java.lang.Long groupId_,
                              boolean singleGroupType_,
                              java.lang.String relationshipType_,
                              int descendentDepth_)
                       throws InvalidGroupException,
                              PrivilegeException
```
    Get a view into the tree pivoted at a particular group. Breadcrumbs will be returned in the TreePivot Each node in the tree will represent a group. The id, name of the node will be id and groupName of the group, and data field of the node will be the group itself.
    
    Parameters:
    
    groupId_ - The id of the group to use as the root of the tree.
    
    singleGroupType_ - true if only groups of the same group type as the root should be returned; false if all groups, regardless of group type, should be returned.
    
    relationshipType_ - The relationship connecting the groups. Currently, the only permissible value is RELATIONSHIP_TYPE_HEIRARCHY
    
    descendentDepth_ - The number of levels below the root that should be returned.
    
    Returns:
    
    The view into the tree.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - This exception is thrown when the user is not a member of the received group
    
    See Also:
    
    Tree
  - getTreeViewForGroup
```
TreePivot getTreeViewForGroup(java.lang.Long groupId_,
                              java.lang.Long[] groupTypeIds_,
                              java.lang.String relationshipType_,
                              int descendentDepth_)
                       throws InvalidGroupException,
                              InvalidGroupTypeException,
                              PrivilegeException
```
    Get a view into the tree pivoted at a particular group Each node in the tree will represent a group. The id, name of the node will be id and groupName of the group, and data field of the node will be the group itself.
    
    Parameters:
    
    groupId_ - The id of the group to use as the root of the tree.
    
    groupTypeIds_ - Only groups of these group types should be returned in the tree.
    
    relationshipType_ - The relationship connecting the groups. Currently, the only permissible value is RELATIONSHIP_TYPE_HEIRARCHY.
    
    descendentDepth_ - The number of levels below the root that should be returned.
    
    Returns:
    
    The view into the tree.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    InvalidGroupTypeException - This exception is thrown whenever an invalid group type id is passed into a service method.
    
    PrivilegeException - This exception is thrown when the user is not a member of the received group
    
    See Also:
    
    Tree
  - getTreeViewForGroupSameTypeWithRoles
```
TreePivot getTreeViewForGroupSameTypeWithRoles(java.lang.Long groupId_,
                                               java.lang.Integer[] roleTypes_,
                                               int descendantDepth_)
                                        throws InvalidGroupException
```
    Get a view into the tree pivoted at a particular group Each node in the tree will represent a group. Only those groups are returned for which the user's privilege matches the specified roles. The id, name of the node will be id and groupName of the group, and data field of the node will be the group itself.
    
    Parameters:
    
    groupId_ - The id of the group to use as the root of the tree.
    
    roleTypes_ - array of roles which should match user's privilege
    
    descendantDepth_ - The number of levels below the root that should be returned.
    
    Returns:
    
    The view into the tree.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - doesGroupExist
```
boolean doesGroupExist(java.lang.Long groupId_)
```
    Checks to see if a given group exists. Returns true if it exists, false if not.
    
    Parameters:
    
    groupId_ - id of the group to check for existence in system.
    
    Returns:
    
    true if given group exists, else false.
  - addGroupsToMyGroups
```
void addGroupsToMyGroups(java.lang.Long[] groupIds_)
                  throws InvalidGroupException
```
    Adds a list of groups to My Groups for logged in user. My Groups is a list of groups that the user is tracking and not groups that the user belongs to or administrates
    
    Parameters:
    
    groupIds_ - groups to add to My Groups
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - removeGroupsFromMyGroups
```
void removeGroupsFromMyGroups(java.lang.Long[] groupIds_)
```
    Removes a list of groups from My Groups for logged-in user. My Groups is a bookmarked list of groups, and ARE NOT groups that the user is a member of or an administrator of.
    
    Parameters:
    
    groupIds_ - groups to remove from My Groups
    
    See Also:
    
    addGroupsToMyGroups(java.lang.Long[])
  - getMyGroupIds
```
java.lang.Long[] getMyGroupIds()
```
    Gets Ids for logged-in user's My Groups. My Groups is a bookmarked list of groups, and ARE NOT groups that the user is a member of or an administrator of.
    
    Returns:
    
    group Ids in users's My Groups list
  - getMyGroups
```
@Deprecated
ResultPage getMyGroups(int startIndex_,
                                   int batchSize_,
                                   java.lang.Integer sortProperty_,
                                   java.lang.Integer sortOrder_)
```
    Deprecated. use getFavoriteGroups
    
    Gets a ResultPage containing a list of groups for logged-in user's My Groups. My Groups is a bookmarked list of groups, and ARE NOT groups that the user is a member of or an administrator of.
    
    Parameters:
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing the Group objects.
  - getGroupSecurityTypes
```
GroupSecurityType[] getGroupSecurityTypes(java.lang.Integer actionId_)
```
    Gets the list of group security types that are available for a particular action. For example, a basic user will only be able to create personal and team groups.
    
    Parameters:
    
    actionId_ - id of the action for which security types are needed. This is one of the ACTION_GROUP_XXX constants
    
    Returns:
    
    the list of group security types for a particular action
  - getGroupMembershipPolicyTypes
```
GroupMemberPolicy[] getGroupMembershipPolicyTypes(java.lang.Long groupSecurityTypeId_)
```
    Gets the list of group membership policy types for a particular group security type. Supported security types are:
    Parameters:
    
    groupSecurityTypeId_ - id of group security type.
    
    Returns:
    
    the list of group membership policy types for a particular group security type
  - getGroupMemberViewingPolicyTypes
```
GroupMemberViewingPolicy[] getGroupMemberViewingPolicyTypes(java.lang.Long groupSecurityTypeId_)
```
    Gets the list of group member viewing policies for a particular group security type. Supported security types are:
    Parameters:
    
    groupSecurityTypeId_ - id of group security type.
    
    Returns:
    
    the list of group member viewing policies for a particular group security type
  - getAllAttributeTypes
```
AttributeType[] getAllAttributeTypes()
```
    Gets the list of group attribute types in the system
    
    Returns:
    
    the list of group attribute types
  - findNonMemberAncestorGroups
```
@Deprecated
Group[] findNonMemberAncestorGroups(GroupSearch groupSearch_,
                                                boolean caseSensitive_,
                                                java.lang.Long groupId_)
                                         throws UnsupportedOperatorException
```
    Deprecated. use findNonMemberAncestorGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead.
    
    Retrieves a result set that consists list of groups for a group search that are not ancestors (by parent-member relationship) of the given group. This is used to prevent circular member relationships. The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup". The supported search operators are specified in GroupSearch for a group
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    groupId_ - the group id
    
    Returns:
    
    the found groups
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - findAvailableParentGroups
```
@Deprecated
Group[] findAvailableParentGroups(GroupSearch groupSearch_,
                                              boolean caseSensitive_,
                                              java.lang.Long groupId_)
                                       throws UnsupportedOperatorException
```
    Deprecated. use findAvailableParentGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Finds all groups available for setting as parent. These will be groups over which the current user has administrative privileges that are also not members of the given group or members of members of the given group. The supported search operators Operator are specified in GroupSearch GroupSearch The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    groupId_ - the group id
    
    Returns:
    
    the found groups
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - findAdminGroups
```
@Deprecated
Group[] findAdminGroups(GroupSearch groupSearch_,
                                    boolean caseSensitive_)
                             throws UnsupportedOperatorException
```
    Deprecated. use findAdminGroupsPaging(com.appiancorp.suiteapi.personalization.GroupSearch, boolean, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Finds groups of which the current user is administrator Supported operators are listed in GroupSearch The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    Returns:
    
    the list of groups meeting the search criteria
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - getRuleSetForGroup
```
RuleSet getRuleSetForGroup(java.lang.Long groupId_)
                    throws InvalidGroupException
```
    Gets membership rule set for a Group
    
    Parameters:
    
    groupId_ - the group id of the group that all these rules belong to.
    
    Returns:
    
    RuleSet for the given roup.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - updateRuleSetForGroup
```
void updateRuleSetForGroup(RuleSet ruleSet_)
                    throws InvalidGroupException
```
    Updates the membership rule set for a Group. Note that there is only one RuleSet for each Group, but each RuleSet may contain multiple rules. This method will replace the current RuleSet with the one passed in.
    
    Parameters:
    
    ruleSet_ - adds the given RuleSet to the group.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - getGroupSummaryForUser
```
@Deprecated
GroupSummary[] getGroupSummaryForUser(java.lang.String username_)
                                           throws InvalidUserException,
                                                  PrivilegeException
```
    Deprecated. Use getGroupSummaryForUserPaging(String, int, int, Integer, Integer) instead.
    
    Gets summaries for the groups of which the given user is a member or administrator. Note: the security on personal groups will further filter out groups of which the user is a member but not an administrator as only administrators of personal groups have permissions to see those groups.
    
    Parameters:
    
    username_ - the username
    
    Returns:
    
    list of GroupSummary
    
    Throws:
    
    InvalidUserException - thrown when an invalid username is passed in.
    
    PrivilegeException
  - getGroupSummaryForUserPaging
```
ResultPage getGroupSummaryForUserPaging(java.lang.String username_,
                                        int startIndex_,
                                        int batchSize_,
                                        java.lang.Integer sortProperty_,
                                        java.lang.Integer sortOrder_)
                                 throws InvalidUserException,
                                        PrivilegeException
```
    Retrieves GroupSummary beans for every group for which the given User is a member or administrator. Note: the security on personal groups will further filter out groups of which the user is a member but not an administrator as only administrators of personal groups have permissions to see those groups.
    
    Parameters:
    
    username_ - The username of the User for which to retrieve the groups.
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted.
    
    sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage which contains an array of GroupSummary objects.
    
    Throws:
    
    InvalidUserException - if the specified User does not exist
    
    PrivilegeException
  - isGroupSystemGroup
```
boolean isGroupSystemGroup(java.lang.Long groupId_)
                    throws InvalidGroupException
```
    Checks to see if a given group is a system group. System groups cannot be deleted, and their names may not be edited.
    
    Parameters:
    
    groupId_ - the group ID
    
    Returns:
    
    true if the given group is a System group, else false.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - getGroupsForUserByRoles
```
@Deprecated
Group[] getGroupsForUserByRoles(java.lang.String username_,
                                            java.lang.Integer[] roles_)
                                     throws UnsupportedRoleException,
                                            InvalidUserException,
                                            PrivilegeException
```
    Deprecated. Use getGroupsForUserByRolesPaging(String, Integer[], int, int, Integer, Integer) instead.
    Retrieves a list of groups for which the given user has any of the given roles. Supported roles are:
    Parameters:
    
    username_ - the user
    
    roles_ - ids of roles
    
    Returns:
    
    the list of groups
    
    Throws:
    
    InvalidUserException - thrown when an invalid username is passed to this service method.
    
    UnsupportedRoleException - thrown when an invalid role id is passed.
    
    PrivilegeException
  - getGroupsForUserByRolesPaging
```
ResultPage getGroupsForUserByRolesPaging(java.lang.String username_,
                                         java.lang.Integer[] roles_,
                                         int startIndex_,
                                         int batchSize_,
                                         java.lang.Integer sortProperty_,
                                         java.lang.Integer sortOrder_)
                                  throws UnsupportedRoleException,
                                         InvalidUserException,
                                         PrivilegeException
```
    Retrieves a ResultPage containing the list of groups for which the given user has any of the given roles. Supported roles are:
    Parameters:
    
    username_ - the user
    
    roles_ - ids of roles
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing list of Group objects.
    
    Throws:
    
    UnsupportedRoleException - thrown when an invalid role id is passed.
    
    InvalidUserException - thrown when an invalid username is passed to this service method.
    
    PrivilegeException
  - getGroupActions
```
java.lang.Boolean[] getGroupActions(java.lang.Long groupId_,
                                    java.lang.Integer[] actionIds_)
                             throws InvalidGroupException
```
    Gets s Boolean array, representing whether actions with the given ids can be performed on a given group by the current user
    
    Parameters:
    
    groupId_ - id of the group
    
    actionIds_ - ids of actions that are requested to be checked. Each of these is one of the ACTION_GROUP_XXX constants
    
    Returns:
    
    Boolean array. An index in the array is Boolean.TRUE if the current user can perform the action at the corresponding index in actionIds_ on the given group
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - canUseGroupName
```
boolean canUseGroupName(java.lang.String groupName_,
                        java.lang.Long groupSecurityType_)
                 throws InvalidSecurityMapException
```
    Indicates whether a user can create a new group with the given name of the given group security type. Public group names must be unique.
    Parameters:
    
    groupName_ - name of the group
    groupSecurityType_ - group security type can be one of the following:
    
    GroupBase.SECURITYMAP_PERSONAL
    
    GroupBase.SECURITYMAP_PUBLIC
    
    GroupBase.SECURITYMAP_TEAM
    Returns:
    
    true if the passed in group name can be used for a group of the given group security type, else false.
    
    Throws:
    
    InvalidSecurityMapException - thrown when a invalid groupSecurity Type is passed.
    
    See Also:
    
    GroupSecurityType
  - getParentGroupsForDelegatedCreation
```
Group[] getParentGroupsForDelegatedCreation()
```
    Gets the groups for which the logged-in user is authorized to set as a parent when creating public child groups. In order to create the public child group, the user must have administrator privileges to the parent group and the parent group must have delegated creation turned on.
    
    Returns:
    
    list of groups that can be used as parent groups.
  - getParentGroupsForDelegatedUpdate
```
Group[] getParentGroupsForDelegatedUpdate(java.lang.Long groupId_)
```
    Gets the groups for which the logged-in user is authorized to set as parent when updating public child groups. This function is similar to getParentGroupsForDelegatedCreation() except that it filters out groups that are members of the passed in group and those that are children or sub-children of the passed in group.
    
    Parameters:
    
    groupId_ - the id of the group
    
    Returns:
    
    list of groups that can be used as parent groups.
  - getParentGroupsForDelegatedCreationPaging
```
ResultPage getParentGroupsForDelegatedCreationPaging(int startIndex_,
                                                     int batchSize_,
                                                     java.lang.Integer sortProperty_,
                                                     java.lang.Integer sortOrder_)
```
    Gets a ResultPage of parent groups for which the logged-in user is authorized to create public child groups.
    
    Parameters:
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of Group objects.
  - findGroupsPaging
```
ResultPage findGroupsPaging(GroupSearch groupSearch_,
                            boolean caseSensitive_,
                            int startIndex_,
                            int batchSize_,
                            java.lang.Integer sortProperty_,
                            java.lang.Integer sortOrder_)
                     throws UnsupportedOperatorException
```
    Finds groups based on criteria submitted in the GroupSearch The supported search operators are specified in GroupSearch for a group See getOperatorsForAttributeType() in GroupTypeService to obtain a list of possible operators Operator for a given data type. The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of groups matching search criteria
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - findNonMemberAncestorGroupsPaging
```
ResultPage findNonMemberAncestorGroupsPaging(GroupSearch groupSearch_,
                                             boolean caseSensitive_,
                                             java.lang.Long groupId_,
                                             int startIndex_,
                                             int batchSize_,
                                             java.lang.Integer sortProperty_,
                                             java.lang.Integer sortOrder_)
                                      throws UnsupportedOperatorException
```
    Retrieves a ResultPage of list of groups for a group search that are not ancestors (by parent-member relationship) of the given group. This is used to prevent circular member relationships. The supported search operators are specified in GroupSearch for a group The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    groupId_ - the id of a group
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of Group objects
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - findAvailableParentGroupsPaging
```
ResultPage findAvailableParentGroupsPaging(GroupSearch groupSearch_,
                                           boolean caseSensitive_,
                                           java.lang.Long groupId_,
                                           int startIndex_,
                                           int batchSize_,
                                           java.lang.Integer sortProperty_,
                                           java.lang.Integer sortOrder_)
                                    throws UnsupportedOperatorException
```
    Gets a ResultPage containing a list of all groups available for setting as parent. These will be groups that the user have administrative privileges and are not members of the given group or members of members of the given group. The supported search operators are specified in GroupSearch The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    groupId_ - the id of a Group
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of Groups objects, representing those groups available to be used as parent groups.
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - findAdminGroupsPaging
```
ResultPage findAdminGroupsPaging(GroupSearch groupSearch_,
                                 boolean caseSensitive_,
                                 int startIndex_,
                                 int batchSize_,
                                 java.lang.Integer sortProperty_,
                                 java.lang.Integer sortOrder_)
                          throws UnsupportedOperatorException
```
    Finds all groups of which you are administrator and which also match the given search criteria. The supported search operators are specified in GroupSearch The GroupSearch object should be populated with the group fields to be searched on, and the criteria to be used in performing the search. For example, the GroupSearch might have the groupName field set to "myGroup" and the operatorGroupName field set to Operator#EQUALS. Such a search will return all groups whose groupName is "myGroup".
    
    Parameters:
    
    groupSearch_ - the group search form
    
    caseSensitive_ - true if search is case sensitive
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of Group objects matching the search criteria.
    
    Throws:
    
    UnsupportedOperatorException - Thrown when a given operation is not supported by the Personalization service.
  - getApplicationName
```
java.lang.String getApplicationName()
```
    Gets the name of the application on which this service is running.
    
    Returns:
    
    the name of the application
  - getWorkspace
```
java.lang.String[] getWorkspace()
```
    Gets the current memory profile for the workspace.
    Returns:
    array of Strings of length 4 describing memory usage:
    
    [0]Used - Memory Used by the Server so far for storage
    
    [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
    
    [2]Mapped - is the space used by memory-mapped files
    
    [3]Available - is the total available memory for the Server process
    
    Note: All usage statistics are in Bytes.
  - getMemberUsernames
```
java.lang.String[] getMemberUsernames(java.lang.Long groupId_)
                               throws InvalidGroupException,
                                      PrivilegeException
```
    Gets the usernames of all the member users for given group
    
    Parameters:
    
    groupId_ - id of the group to get users for
    
    Returns:
    
    a string array of usernames. Note: If the user can see the group but cannot view members of group, the returned array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException
  - getGroupIdsForUserByRoles
```
java.lang.Long[][] getGroupIdsForUserByRoles(java.lang.String username_,
                                             java.lang.Integer[] roles_)
                                      throws InvalidUserException,
                                             UnsupportedRoleException,
                                             PrivilegeException
```
    Gets the group Ids for which the specified user has any of the specified roles
    
    Parameters:
    
    username_ - the user
    
    roles_ - ids of roles
    
    Returns:
    
    ids of groups where user has any of the given roles.
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid username is passed into a service method.
    
    UnsupportedRoleException - This exception is thrown whenever an invalid role id is passed into a service method.
    
    PrivilegeException
  - getGroupsList
```
ResultList getGroupsList(java.lang.Long[] groupIds_)
```
    Returns a ResultList ResultList containing error codes for all Ids and Groups for valid Ids
    
    Parameters:
    
    groupIds_ - Ids of groups to retrieve
    
    Returns:
    
    ResultList containing Group group objects, and error codes. Each error code will be one of the CODE_XXX constants in ResultList
  - getMemberGroupsDirect
```
Group[] getMemberGroupsDirect(java.lang.Long groupId_)
                       throws InvalidGroupException,
                              PrivilegeException
```
    Gets group members of a group that are explicitly defined, no cascading (group members of subgroups are not included)
    
    Parameters:
    
    groupId_ - the group to get group members for
    
    Returns:
    
    array of member groups. Note: If the user can see the group but cannot view members of groupg, the returned array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if there is a security violation
  - getMemberGroupsDirectPaging
```
ResultPage getMemberGroupsDirectPaging(java.lang.Long groupId_,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidGroupException,
                                       PrivilegeException
```
    Gets a ResultPage containing a list of groups that are direct members, i.e. group members of subgroups are not included in the result set.
    
    Parameters:
    
    groupId_ - the group to get members for
    
    startIndex_ - the index of the first Group that will be returned
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the Group objects will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing Group objects, representing the group member. Note: If the user can see the group but cannot view members of the group, the results array will be of length 0.
    
    Throws:
    
    ServiceException - if any system-level error occurs
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if there is a security violation
  - getMemberUsersDirect
```
@Deprecated
User[] getMemberUsersDirect(java.lang.Long groupId_)
                                 throws InvalidGroupException,
                                        PrivilegeException
```
    Deprecated. Use getMemberUsersDirectPaging(Long, int, int, Integer, Integer)
    
    Gets a list of distinct users that are direct members of the specified group, i.e user members of subgroups are not included.
    
    Parameters:
    
    groupId_ - the group to get members for.
    
    Returns:
    
    array of member users. Note: If the current user can see the group but cannot view members of group, the returned array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if there is a security violation
  - getMemberUsersDirectPaging
```
ResultPage getMemberUsersDirectPaging(java.lang.Long groupId_,
                                      int startIndex_,
                                      int batchSize_,
                                      java.lang.Integer sortProperty_,
                                      java.lang.Integer sortOrder_)
                               throws InvalidGroupException,
                                      PrivilegeException
```
    Gets a ResultPage containing a list of distinct users that are direct members of the specified group i.e user members of subgroups are not included.
    
    Parameters:
    
    groupId_ - the group to get members for.
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in User
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of User objects, representing the direct member users of the group. Note: If the current user can see the group but cannot view members of group, the results array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if there is a security violation
  - getAdminUsersDirectPaging
```
ResultPage getAdminUsersDirectPaging(java.lang.Long groupId_,
                                     int startIndex_,
                                     int batchSize_,
                                     java.lang.Integer sortProperty_,
                                     java.lang.Integer sortOrder_)
                              throws InvalidGroupException,
                                     PrivilegeException
```
    Gets a ResultPage containing a list of distinct users that are direct admins of the specified group ie user admins of subgroups are not included.
    
    Parameters:
    
    groupId_ - the group to get admins for.
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in User
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing a list of User objects, representing the direct user admins of the group. Note: If the current user can see the group but cannot view members of group, the results array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if there is a security violation
  - getMemberUsernamesDirect
```
@Deprecated
java.lang.String[] getMemberUsernamesDirect(java.lang.Long groupId_)
                                                 throws InvalidGroupException,
                                                        PrivilegeException
```
    Deprecated. Use getMemberUsersDirectPaging(Long, int, int, Integer, Integer)
    
    Gets the usernames of all the direct member users for given group ie user members of subgroups are not included.
    
    Parameters:
    
    groupId_ - id of the Group to get users for
    
    Returns:
    
    a string array of usernames. Note: If the current user can see the group but cannot view members of the group, the returned array will be of length 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if there is a security violation
  - getTopLevelGroupsForHierarchy
```
GroupHierarchyBean[] getTopLevelGroupsForHierarchy(java.lang.Long groupTypeId_,
                                                   boolean sameType_)
                                            throws InvalidGroupTypeException
```
    Parameters:
    
    groupTypeId_ -
    
    sameType_ -
    
    Returns:
    
    Throws:
    
    InvalidGroupTypeException - This exception may be thrown by service methods detecting that a given GroupType does not exist.
    
    java.lang.SecurityException - if there is a security violation
  - getTopLevelGroupsForHierarchyPaging
```
ResultPage getTopLevelGroupsForHierarchyPaging(java.lang.Long groupTypeId_,
                                               boolean sameType_,
                                               int startIndex_,
                                               int batchSize_,
                                               java.lang.Integer sortProperty_,
                                               java.lang.Integer sortOrder_)
                                        throws InvalidGroupTypeException
```
    Gets all top level GroupHierarchyBean objects ( Groups without a parent group) given the Group type.
    
    Parameters:
    
    groupTypeId_ - The type of the Group to retrieve.
    
    sameType_ - Affects the value of the hasChildren field. If true, then hasChildren is only true if the Group has children of the same Group type. If false, then hasChildren is true if the Group has any children at all.
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This should be one of the SORTY_BY_XXX constants in GroupHierarchyBean.
    
    sortOrder_ - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    A ResultPage containing an array of Group objects.
    
    Throws:
    
    InvalidGroupTypeException - If the groupTypeId_ parameter does not correspond to an existing Group type.
  - areUsersAddedByRule
```
boolean[] areUsersAddedByRule(java.lang.Long groupId_,
                              java.lang.String[] userIds_)
                       throws InvalidUserException,
                              InvalidGroupException
```
    Checks to see if the given users where added to the group by a rule.
    
    Parameters:
    
    groupId_ - The id of the group that contains the users that are being checked.
    
    userIds_ - The ids of the users being checked to see if they were added by a rule.
    
    Returns:
    
    A Boolean array the length of userIds_ that contains as a value in each element either true or false. true means the user was added by a rule, while false means it was not.
    
    Throws:
    
    InvalidUserException - This exception is thrown whenever an invalid user id is passed into a service method.
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - areGroupsAddedByRule
```
boolean[] areGroupsAddedByRule(java.lang.Long groupId_,
                               java.lang.Long[] groupIds_)
                        throws InvalidGroupException
```
    Checks to see if the given groups were added to the group by a rule.
    
    Parameters:
    
    groupId_ - The id of the group that contains the users that are being checked.
    
    groupIds_ - The ids of the groups being checked to see if they were added by a rule.
    
    Returns:
    
    A Boolean array the length of groupIds_ that contains as a value in each element either true or false. true means the user was added by a rule, while false means it was not.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
  - suggestGroups
```
@Deprecated
java.lang.String suggestGroups(java.lang.String query_,
                                           int maxSuggestions_)
```
    Deprecated. use suggest(String, int, SuggestParam[], Boolean) instead
    
    Returns a String in a specified format that contains Groups whose name matches or partially matches the query string. The number of suggestions is limited. Format (for Users and Groups: [[4, 'john.user', John User],[5, 32, 'Finance']]
    
    Parameters:
    
    query_ - The search query.
    
    maxSuggestions_ - The maximum number of suggestions to return.
    
    Returns:
    
    A String of suggestions in the specified format.
  - suggestUsersAndGroups
```
@Deprecated
java.lang.String suggestUsersAndGroups(java.lang.String query_,
                                                   int maxSuggestions_)
```
    Deprecated. use suggest(String, int, SuggestParam[], Boolean) instead
    
    Returns a String in a format specified by UI that contains Users whose first, last, or username match or partially match the query string and Groups whose name matches or partially matches the query string. The number of suggestions is limited. Format (for Users and Groups: [[4, 'john.user', John User],[5, 32, 'Finance']]
    
    Parameters:
    
    query_ - The search query.
    
    maxSuggestions_ - The maximum number of suggestions to return.
    
    Returns:
    
    A String of suggestions in the specified format.
  - suggestGroupsBulk
```
@Deprecated
Suggestion[][] suggestGroupsBulk(java.lang.String[] queries_,
                                             int maxSuggestionsPerQuery_)
```
    Deprecated. use suggest(String, int, SuggestParam[], Boolean) instead
    
    Suggests Groups whose name matches each query.
    
    Parameters:
    
    queries_ - An array of queries by which to search for Groups.
    
    maxSuggestionsPerQuery_ - The maximum number of suggestions to return for each query.
    
    Returns:
    
    An array of Suggestion[] which are the suggestions corresponding to each query string. The first dimension of the array is equal to the number of queries. The second dimension of the array is less than or equal to the max suggestions per query.
  - suggestUsersAndGroupsBulk
```
@Deprecated
Suggestion[][] suggestUsersAndGroupsBulk(java.lang.String[] queries_,
                                                     int maxSuggestionsPerQuery_)
```
    Deprecated. use suggest(String, int, SuggestParam[], Boolean) instead
    
    Suggests Users whose first, last, and usernames match each query and Groups whose name matches each query.
    
    Parameters:
    
    queries_ - An array of queries by which to search for Groups.
    
    maxSuggestionsPerQuery_ - The maximum number of suggestions to return for each query.
    
    Returns:
    
    An array of Suggestion[] which are the suggestions corresponding to each query string. The first dimension of the array is equal to the number of queries. The second dimension of the array is less than or equal to the max suggestions per query.
  - getUserDefaultApplication
```
@Deprecated
java.lang.Long getUserDefaultApplication(java.lang.String username)
```
    Deprecated. Use ApplicationService.getDefaultApplication() for the site-wide default.
    
    There are no user-specific default applications. The results of this method should not be used.
    
    Parameters:
    
    username - the user for which to fetch the application
    
    Returns:
    
    null since there are no user-specific default applications.
  - getSystemDefaultApplication
```
@Deprecated
java.lang.Long getSystemDefaultApplication()
```
    Deprecated. Use ApplicationService.getDefaultApplication()
    
    Gets the preferred default application for the system
    
    Returns:
    
    the default application chosen by the Administrator
  - getMyHomePage
```
java.lang.String getMyHomePage()
```
    Gets the home page for the current user if he has set one, otherwise returns the global home page.
    
    Returns:
    
    the absolute url of the home page for the user (i.e. /portal/home.do).
  - setGlobalHomePage
```
void setGlobalHomePage(java.lang.String url)
                throws PrivilegeException
```
    Sets home page for all users (default). Only can be called by system administrators.
    
    Parameters:
    
    url - the absolute url of the default home page for all users (i.e. /portal/home.do).
    
    Throws:
    
    PrivilegeException - Thrown when the user does not have privileges to create a Group.
  - setHomePageForUser
```
void setHomePageForUser(java.lang.String username_,
                        java.lang.String url_)
                 throws InvalidUserException,
                        PrivilegeException
```
    Throws:
    
    InvalidUserException
    
    PrivilegeException
  - setMyHomePage
```
void setMyHomePage(java.lang.String url)
            throws java.lang.Exception
```
    Sets home page for current user, overriding the system default for this user.
    
    Parameters:
    
    url - the absolute url of the page
    
    Throws:
    
    java.lang.Exception - if there is any error
  - getGlobalHomePage
```
java.lang.String getGlobalHomePage()
```
    Gets the global home page for the application.
    
    Returns:
    
    the absolute url of the default home page for all users (i.e. /portal/home.do).
  - addGroupToFavorites
```
void addGroupToFavorites(java.lang.Long groupId_)
                  throws InvalidGroupException
```
    Associates Group as one of the current User's favorites
    
    Parameters:
    
    groupId_ - the id of the group that is to be added to user's favorites
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id or group name is passed into a service method.
  - removeGroupFromFavorites
```
void removeGroupFromFavorites(java.lang.Long groupId_)
                       throws InvalidGroupException
```
    removes this group (groupId_) as one of the current user's favorites
    
    Parameters:
    
    groupId_ - the id of the group that is to be removed from user's favorites
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id or group name is passed into a service method.
  - getFavoriteGroups
```
ResultPage getFavoriteGroups(int startIndex_,
                             int batchSize_,
                             java.lang.Integer sortProperty_,
                             java.lang.Integer sortOrder_)
```
    Gets a ResultPage containing a list of groups for the current user's Favorite Groups. Replaces getMyGroups.
    
    Parameters:
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    a ResultPage containing the Group objects.
  - addAdminUsers
```
void addAdminUsers(java.lang.String[] usernames_,
                   java.lang.Long groupId_)
            throws InvalidUserException,
                   InvalidGroupException,
                   PrivilegeException
```
    Adds the users by given username's as administrators of group given by groupId_
    
    Parameters:
    
    usernames_ - username's of the users to be added as administrators.
    
    groupId_ - the group to add the administrator to.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed for the groupId_
    
    PrivilegeException - This exception is thrown when the user does not have privileges to add the group(s) as adminsitrators
    
    InvalidUserException
  - removeAdminUsers
```
void removeAdminUsers(java.lang.String[] usernames_,
                      java.lang.Long groupId_)
               throws InvalidUserException,
                      InvalidGroupException,
                      PrivilegeException
```
    Removes the users specified by usernames_ as administrators of group
    
    Parameters:
    
    usernames_ - username's of the users to be removed.
    
    groupId_ - the target group whose administrators are updated
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed for the groupId_
    
    PrivilegeException - This exception is thrown when the user does not have privileges to remove the user(s)
    
    InvalidUserException
  - addAdminGroups
```
void addAdminGroups(java.lang.Long[] adminGroupIds_,
                    java.lang.Long groupId_)
             throws InvalidGroupException,
                    PrivilegeException
```
    Adds the given groups as administrator groups for group given by groupId_
    
    Parameters:
    
    adminGroupIds_ - Ids of the group to be added as administrators.
    
    groupId_ - the group to add the administrator to.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed for either the groupId_ or the groups to be added as administrator
    
    PrivilegeException - This exception is thrown when the user does not have privileges to add the group(s) as adminsitrators
  - removeAdminGroups
```
void removeAdminGroups(java.lang.Long[] adminGroupIds_,
                       java.lang.Long groupId_)
                throws InvalidGroupException,
                       PrivilegeException
```
    Removes the groups specified by adminGroupIds_ as administrators of group
    
    Parameters:
    
    adminGroupIds_ - Ids of the group to be removed.
    
    groupId_ - the target group whose administrators are updated
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed for either the groupId_ or the groups to be removed as administrators
    
    PrivilegeException - This exception is thrown when the user does not have privileges to remove the group(s)
  - getAdminGroupsPaging
```
ResultPage getAdminGroupsPaging(java.lang.Long groupId_,
                                int startIndex_,
                                int batchSize_,
                                java.lang.Integer sortProperty_,
                                java.lang.Integer sortOrder_)
                         throws InvalidGroupException,
                                PrivilegeException
```
    Retrieves the groups that are administrator groups for the given groupId_
    
    Parameters:
    
    groupId_ - Id of the group whose administrator groups are requested
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Group
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    ResultPage containing a list of Group objects that are administrator groups.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed for the groupId_
    
    PrivilegeException - This exception is thrown whenever the user does not have view privileges to group specified by groupId_
  - getAdminUsersPaging
```
ResultPage getAdminUsersPaging(java.lang.Long groupId_,
                               int startIndex_,
                               int batchSize_,
                               java.lang.Integer sortProperty_,
                               java.lang.Integer sortOrder_)
                        throws InvalidGroupException,
                               PrivilegeException
```
    Retrieves the users that are administrator users for the given groupId_
    
    Parameters:
    
    groupId_ - Id of the group whose administrator groups are requested
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in User
    
    sortOrder_ - the order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.
    
    Returns:
    
    ResultPage containing a list of User objects that are administrator users.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed for the groupId_
    
    PrivilegeException - This exception is thrown whenever the user does not have view privileges to group specified by groupId_
  - getAdminUserCount
```
int getAdminUserCount(java.lang.Long groupId_)
               throws InvalidGroupException,
                      PrivilegeException
```
    Gets a count of distinct users that are administrators of the specified group.
    
    Parameters:
    
    groupId_ - the group whose user members are to be counted
    
    Returns:
    
    the count of member users. Note: If the user can see the group but cannot view members of group, the returned member count will be 0.
    
    Throws:
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user does not have sufficient privileges
  - getAdminGroupCount
```
int getAdminGroupCount(java.lang.Long groupId_)
                throws InvalidGroupException,
                       PrivilegeException
```
    Gets the number of distinct groups {that are administrators of the specified group.
    
    Parameters:
    
    groupId_ - the group to count group members of.
    
    Returns:
    
    the count. Note: If the current user can see the group but cannot view members of group, the returned member count will be 0.
    
    Throws:
    
    ServiceException - if any system-level error occurs
    
    InvalidGroupException - This exception is thrown whenever an invalid group id is passed into a service method.
    
    PrivilegeException - if the user does not have sufficient privileges
  - isMemberOfGroups
```
boolean[] isMemberOfGroups(java.lang.Long[] groupId_)
```
    Determines if the current user is a member of each of the specified groups.
    
    Parameters:
    
    groupId_ - array of group ids
    
    Returns:
    
    a boolean array of same length as the input parameter. For each group in the list, if the current user is a member of the group a true is returned. If the user is not a member, cannot see the group, the passed group is null or it does not exist, false is returned. If groupId_ is null or empty, an empty boolean array is returned.
  - isMemberOfGroups
```
boolean[] isMemberOfGroups(java.lang.String[] groupUuid_)
```
    Determines if the current user is a member of each of the specified groups.
    
    Parameters:
    
    groupUuid_ - array of group UUIDs.
    
    Returns:
    
    a boolean array of same length as the input parameter. For each group in the list, if the current user is a member of the group a true is returned. If the user is not a member, cannot see the group, the passed group is null or it does not exist, false is returned. If groupId_ is null or empty, an empty boolean array is returned.
  - isUserMemberOfGroups
```
boolean[] isUserMemberOfGroups(java.lang.String username_,
                               java.lang.Long[] groupId_)
                        throws InvalidUserException
```
    Determines if the specified user is a member of each of the specified groups.
    
    Parameters:
    
    username_ - username
    
    groupId_ - array of group ids
    
    Returns:
    
    a boolean array of same length as the input parameter. For each group in the list, if the current user is a member of the group a true is returned. If the user is not a member, cannot see the group, or the group does not exist, false is returned. If username_ is null or empty, or groupId_ is null or empty, an empty boolean array is returned.
    
    Throws:
    
    InvalidUserException - If the passed username is invalid.
  - isUserMemberOfGroups
```
boolean[] isUserMemberOfGroups(java.lang.String username_,
                               java.lang.String[] groupUuid_)
                        throws InvalidUserException
```
    Determines if the specified user is a member of each of the specified groups.
    
    Parameters:
    
    username_ - username
    
    groupUuid_ - array of group uuids
    
    Returns:
    
    a boolean array of same length as the input parameter. For each group in the list, if the current user is a member of the group a true is returned. If the user is not a member, cannot see the group, or the group does not exist, false is returned. If username_ is invalid, or groupId_ is null or empty, an empty boolean array is returned.
    
    Throws:
    
    InvalidUserException - If the passed username is either null or empty.
  - isUserMemberOfGroups
```
boolean[] isUserMemberOfGroups(java.lang.String[] usernames,
                               java.lang.Long[] groupId_)
                        throws InvalidUserException
```
    Determines if the specified user is a member of each of the specified groups.
    
    Parameters:
    
    usernames - usernames
    
    groupId_ - array of group ids
    
    Returns:
    
    a boolean array of same length as groupId_. This call presumes that all usernames are potential usernames for the same user. For each group in the list, if the specified user is a member of the group a true is returned. If the user is not a member, cannot see the group, or the group does not exist, false is returned. If all usernames are null, or groupId_ is null or empty, an empty boolean array is returned. Multiple passed usernames should not be valid (use areUsersMembersOfGroups to check multiple users), but if so, results for the first will be returned.
    
    Throws:
    
    InvalidUserException - If all passed usernames are invalid.
  - isUserMemberOfGroups
```
boolean[] isUserMemberOfGroups(java.lang.String[] usernames,
                               java.lang.String[] groupUuid_)
                        throws InvalidUserException
```
    Determines if the specified user is a member of each of the specified groups.
    
    Parameters:
    
    usernames - usernames
    
    groupUuid_ - array of group uuids
    
    Returns:
    
    a boolean array of same length as groupId_. This call presumes that all usernames are potential usernames for the same user. For each group in the list, if the specified user is a member of the group a true is returned. If the user is not a member, cannot see the group, or the group does not exist, false is returned. If all usernames are null, or groupId_ is null or empty, an empty boolean array is returned. Multiple passed usernames should not be valid (use areUsersMembersOfGroups to check multiple users), but if so, results for the first will be returned.
    
    Throws:
    
    InvalidUserException - If all passed usernames are invalid.
  - areUsersMembersOfGroups
```
boolean[][] areUsersMembersOfGroups(java.lang.String[] usernames,
                                    java.lang.Long[] groupIds)
                             throws InvalidUserException
```
    Determines if the specified user is a member of each of the specified groups.
    
    Parameters:
    
    usernames -
    
    groupIds - array of group ids
    
    Returns:
    
    a 2D boolean array of same length as the input parameter usernames. For each user in the list, for each group in the list, if the user is a member of the group a true is returned. If the user is not a member, cannot see the group, or the group does not exist, false is returned.
    
    Throws:
    
    InvalidUserException
  - areUsersMembersOfGroups
```
boolean[][] areUsersMembersOfGroups(java.lang.String[] usernames,
                                    java.lang.String[] groupUuid_)
                             throws InvalidUserException
```
    Determines if the specified user is a member of each of the specified groups.
    
    Parameters:
    
    usernames -
    
    groupUuid_ - array of group uuids
    
    Returns:
    
    a 2D boolean array of same length as the input parameter usernames. For each user in the list, for each group in the list, if the user is a member of the group a true is returned. If the user is not a member, cannot see the group, or the group does not exist, false is returned.
    
    Throws:
    
    InvalidUserException
  - getDirectMemberGroupIds
```
java.lang.Long[] getDirectMemberGroupIds(java.lang.Long groupId)
                                  throws InvalidGroupException,
                                         PrivilegeException
```
    Gets the group IDs of all the member groups added directly to a given group (excludes those who are members via rule or via membership in a member group)
    
    Parameters:
    
    groupId - id of the group for which to get member groups
    
    Returns:
    
    Long array of groupIds
    
    Throws:
    
    InvalidGroupException - if the group ID is invalid
    
    PrivilegeGroupException - if the user does not have rights to view the group
    
    PrivilegeException
  - getDirectMemberUsernames
```
java.lang.String[] getDirectMemberUsernames(java.lang.Long groupId)
                                     throws InvalidGroupException,
                                            PrivilegeException
```
    Gets the usernames of all the member users added directly to a given group (excludes those who are members via rule or via membership in a member group)
    
    Parameters:
    
    groupId - id of the group for which to get member users
    
    Returns:
    
    String array of usernames
    
    Throws:
    
    InvalidGroupException - if the group ID is invalid
    
    PrivilegeGroupException - if the user does not have rights to view the group
    
    PrivilegeException
  - getDirectAdminGroupIds
```
java.lang.Long[] getDirectAdminGroupIds(java.lang.Long groupId)
                                 throws InvalidGroupException,
                                        PrivilegeException
```
    Gets the group IDs of all the administrator groups added directly to a given group (excludes those who are administrators via membership in an administrator group)
    
    Parameters:
    
    groupId - id of the group for which to get admin groups
    
    Returns:
    
    Long array of groupIds
    
    Throws:
    
    InvalidGroupException - if the group ID is invalid
    
    PrivilegeGroupException - if the user does not have rights to view the group
    
    PrivilegeException
  - getDirectAdminUsernames
```
java.lang.String[] getDirectAdminUsernames(java.lang.Long groupId)
                                    throws InvalidGroupException,
                                           PrivilegeException
```
    Gets the usernames of all the administrator users added directly to a given group (excludes those who are administrators via membership in an administrator group)
    
    Parameters:
    
    groupId - id of the group for which to get admin users
    
    Returns:
    
    String array of usernames
    
    Throws:
    
    InvalidGroupException - if the group ID is invalid
    
    PrivilegeGroupException - if the user does not have rights to view the group
    
    PrivilegeException
  - suggest
```
java.lang.String suggest(java.lang.String query,
                         int maxItems,
                         SuggestParam[] params,
                         java.lang.Boolean groupResults)
```
    Parameters:
    
    query -
    
    maxItems -
    
    params - list of information on what is being suggested and what format the results should be in. valid types are group, user.
    
    groupResults - if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.
    
    Returns:
    
    a JSON formatted string
  - suggest
```
java.lang.String suggest(java.lang.String query,
                         int maxItems,
                         SuggestParam[] params,
                         java.lang.Boolean groupResults,
                         java.lang.Long[] allowList)
```
    Parameters:
    
    query -
    
    maxItems -
    
    params - list of information on what is being suggested and what format the results should be in. valid types are group, user.
    
    groupResults - if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.
    
    allowList - list of IDs that will be automatically added to returned results, filtered by query. Ignored if null or empty.
    
    Returns:
    
    a JSON formatted string
  - resolveEmailAddress
```
@Deprecated
ResolvedEmailAddresses resolveEmailAddress(LocalObject emailRecipient_)
                                                throws InvalidGroupException,
                                                       InvalidUserException,
                                                       PrivilegeException
```
    Deprecated. Use resolveEmailDestinations(LocalObject[], LocalObject[], LocalObject[])
    
    Resolves an email recipient into an email address. Only LocalObjects of types USER, GROUP, and EMAIL_ADDRESS are valid inputs; any other inputs will result in an IllegalArgumentException. All LocalObject inputs must be valid: they all must contain a non-null type and either a non-null id or stringId, depending on the type.
    
    Parameters:
    
    emailRecipient_ - the LocalObject representing an email recipient for which to retrieve the email address information.
    
    Returns:
    
    the resolved email addresses
    
    Throws:
    
    InvalidGroupException - if the recipient type is GROUP and the id is not valid
    
    InvalidUserException - if the recipient type is USER and the id is not valid
    
    PrivilegeException - if the user doesn't have rights to see the address
  - resolveEmailAddresses
```
@Deprecated
ResolvedEmailAddresses resolveEmailAddresses(LocalObject[] emailRecipients_)
```
    Deprecated. Use resolveEmailDestinations(LocalObject[], LocalObject[], LocalObject[])
    
    Resolves email recipients into email addresses. Only LocalObjects of types USER, GROUP, and EMAIL_ADDRESS are valid inputs; any other inputs will result in an IllegalArgumentException. All LocalObject inputs must be valid: they all must contain a non-null type and either a non-null id or stringId, depending on the type.
    
    Parameters:
    
    emailRecipients_ - the LocalObject[] representing email recipients for which to retrieve the email address information.
    
    Returns:
    
    resolved email addresses and information on recipients that failed to resolve
  - resolveEmailDestinations
```
ResolvedEmailAddresses[] resolveEmailDestinations(LocalObject[] to_,
                                                  LocalObject[] cc_,
                                                  LocalObject[] bcc_)
```
    Resolves three sets of email recipients, which form the email destination, into email addresses. Only LocalObjects of types USER, GROUP, and EMAIL_ADDRESS are valid inputs; any other inputs will result in an IllegalArgumentException. All LocalObject inputs must be valid: they all must contain a non-null type and either a non-null id or stringId, depending on the type.
    
    Parameters:
    
    to_ - the LocalObject[] representing email recipients for the "to" field
    
    cc_ - the LocalObject[] representing email recipients for the "cc" field
    
    bcc_ - the LocalObject[] representing email recipients for the "bcc" field
    
    Returns:
    
    the resolved email addresses
    
    See Also:
    
    resolveEmailAddresses
  - changeGroupTypeOfGroup
```
void changeGroupTypeOfGroup(java.lang.Long groupId,
                            java.lang.Long newGroupTypeId)
                     throws PrivilegeException,
                            InvalidGroupException,
                            InvalidGroupTypeException
```
    Changes the GroupType of a Group. NOTE: values of dynamic attributes for group will be lost -- group will have default values for dynamic attributes of new groupType.
    
    Parameters:
    
    groupId - id of group to change grouptype of
    
    newGroupTypeId - newGroupTypeId id of groupType to change group to
    
    Throws:
    
    PrivilegeException - if user is not a SystemAdministrator-type user
    
    InvalidGroupException - if groupId is invalid
    
    InvalidGroupTypeException - if newGroupTypeId is invalid
  - changeGroupTypesOfGroups
```
java.lang.Integer[] changeGroupTypesOfGroups(java.lang.Long[] groupIds,
                                             java.lang.Long[] newGroupTypeIds)
                                      throws java.lang.IllegalArgumentException
```
    Changes the GroupTypes of Groups. NOTE: groupIds should have same length as newGroupTypeIds NOTE: values of dynamic attributes for group will be lost -- groups will have default values for dynamic attributes of new groupTypes
    
    Parameters:
    
    groupIds - ids of groups to change grouptypes of
    
    newGroupTypeIds - ids of groupTypes to change groups to
    
    Returns:
    
    Integer array containing success or error codes. This is one of the GROUP_TYPE_CHANGE_XXX Constants
    
    Throws:
    
    java.lang.IllegalArgumentException - if groupIds not unique
  - validateTypedValues
```
boolean validateTypedValues(TypedValue[] typedValues)
                     throws InvalidGroupException,
                            InvalidUserException
```
    Validates given TypedValues. This method is free to throw an exception or to return false if any TypedValue passed is invalid for this engine. This engine supports: AppianType.GROUP AppianType.USERNAME AppianType.USER_OR_GROUP AppianType.EMAIL_RECIPIENT
    
    Parameters:
    
    typedValues -
    
    Returns:
    
    true if valid, false if invalid
    
    Throws:
    
    InvalidGroupException
    
    InvalidUserException

Interface GroupService

Field Summary

Fields inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

Method Summary

Methods inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

Field Detail

USER_ROLE_SUPERADMIN

USER_ROLE_CREATOR

USER_ROLE_ADMINISTRATOR

USER_ROLE_VIEWER

USER_ROLE_MEMBER

USER_ROLE_NONMEMBER

RELATIONSHIP_TYPE_HEIRARCHY

ACTION_GROUP_DELETE_GROUP

ACTION_GROUP_EDIT_GROUP_ATTRIBUTES

ACTION_GROUP_ADD_GROUP_MEMBERS

ACTION_GROUP_DELETE_GROUP_MEMBERS

ACTION_GROUP_ADD_GROUP_RULES

ACTION_GROUP_DELETE_GROUP_RULES

ACTION_GROUP_VIEW_GROUP_EXISTENCE

ACTION_GROUP_VIEW_GROUP_ATTRIBUTES

ACTION_GROUP_VIEW_GROUP_MEMBERS

ACTION_GROUP_VIEW_GROUP_RULES

ACTION_GROUP_ADD_SELF_TO_GROUP

ACTION_GROUP_REMOVE_SELF_FROM_GROUP

ACTION_GROUP_UPDATE_DELEGATED_ADMINISTRATION

ACTION_GROUP_USE_GROUP_AS_DELEGATED_PARENT

GROUP_TYPE_CHANGE_SUCCESS

GROUP_TYPE_CHANGE_NO_PRIVILEGE

GROUP_TYPE_CHANGE_INVALID_GROUP

GROUP_TYPE_CHANGE_INVALID_GROUPTYPE

createGroup$UPDATES

createGroups$UPDATES

updateGroup$UPDATES

updateGroups$UPDATES

deleteGroup$UPDATES

getGroupName$UPDATES

getGroupNames$UPDATES

getGroupNamesList$UPDATES

getGroupAttribute$UPDATES

getGroup$UPDATES

getGroups$UPDATES

getCredentials$UPDATES

getCachedCredentials$UPDATES

getGroupsOfType$UPDATES

getGroupsOfTypePaging$UPDATES

getGroupTypeForGroup$UPDATES

getGroupIdsForUserByRole$UPDATES

getGroupsForUserByRole$UPDATES

getGroupsForUserByRolePaging$UPDATES

getGroupsOfTypeForMemberUser$UPDATES

getMemberGroups$UPDATES

getMemberGroupsPaging$UPDATES

getMemberUsers$UPDATES

getMemberUsersPaging$UPDATES

getMemberUserCount$UPDATES

getMemberGroupCount$UPDATES

addMemberGroup$UPDATES

addMemberGroups$UPDATES

addMemberUser$UPDATES

addMemberUsers$UPDATES

addMyselfToGroup$UPDATES

removeMemberGroup$UPDATES

removeMemberGroups$UPDATES

removeMemberUser$UPDATES

removeMemberUsers$UPDATES

removeMyselfFromGroup$UPDATES

findGroups$UPDATES

isGroupDescendant$UPDATES

isUserMember$UPDATES

getRootTrees$UPDATES

getRootTreesSameTypeWithRoles$UPDATES

getTopLevelGroupsPaging$UPDATES

getTreeViewForGroup$UPDATES

getTreeViewForGroupSameTypeWithRoles$UPDATES

doesGroupExist$UPDATES

addGroupsToMyGroups$UPDATES

removeGroupsFromMyGroups$UPDATES

getMyGroupIds$UPDATES

getMyGroups$UPDATES