Uses of Interface
com.ibm.openpages.api.security.IGroup

Packages that use IGroup

Package	Description
com.ibm.openpages.api.security	Provides interfaces to work with the OpenPages security data: users, groups, and role-based security.
com.ibm.openpages.api.service	Provides the main interfaces to work with the API services.

Uses of IGroup in com.ibm.openpages.api.security

Methods in com.ibm.openpages.api.security that return IGroup

Modifier and Type	Method and Description
IGroup	IAdminPermission.getGroup() Returns IGroup of the security domain on which this administrative permission applies.

Methods in com.ibm.openpages.api.security that return types with arguments of type IGroup

Modifier and Type	Method and Description
java.util.Iterator<IGroup>	IUser.getGroups() Returns all the groups the user belongs to.
java.util.Iterator<IGroup>	IGroup.getParentGroups() Returns this group membership to other groups.
java.util.Iterator<IGroup>	IGroup.getSubGroups() Returns all groups that are members of a security group.

Methods in com.ibm.openpages.api.security with parameters of type IGroup

Modifier and Type	Method and Description
boolean	IUser.isMember(IGroup group) Verifies membership to the specified group.

Uses of IGroup in com.ibm.openpages.api.service

Methods in com.ibm.openpages.api.service that return IGroup

Modifier and Type	Method and Description
IGroup	ISecurityService.createGroup(GroupInfo groupInfo) Creates new security group based on provided group specification.
IGroup	ISecurityService.createGroup(GroupInfo groupInfo, IGroup parentGroup) Creates new security group based on provided group specification and parent group.
IGroup	ISecurityService.getGroup(Id groupId) Retrieves group by Id.
IGroup	ISecurityService.getGroup(Id groupId, GroupOptions options) Retrieves group by Id.
IGroup	ISecurityService.getGroup(java.lang.String groupName) Retrieves group by name.
IGroup	ISecurityService.getGroup(java.lang.String groupName, GroupOptions options) Retrieves group by name.

Methods in com.ibm.openpages.api.service that return types with arguments of type IGroup

Modifier and Type	Method and Description
java.util.Iterator<IGroup>	ISecurityService.getAccessibleGroups() Retrieves all groups accessible by current user.
java.util.Iterator<IGroup>	ISecurityService.getGroups(boolean includeActiveGroupsOnly) Retrieves groups from the OpenPages security system.
java.util.Iterator<IGroup>	ISecurityService.getTopLevelGroups() Retrieves top level security groups from the OpenPages security model.

Methods in com.ibm.openpages.api.service with parameters of type IGroup

Modifier and Type	Method and Description
void	ISecurityService.assignRole(IGroup group, IRoleTemplate roleTemplate, IFolder folder) Assigns role to specified group for the given folder.
void	ISecurityService.assignRoles(IGroup group, java.util.List<IRoleTemplate> roleTemplates, java.util.List<IFolder> folders) Assigns each of the roles in the roleTemplates list to specified group in each of the folders.
IGroup	ISecurityService.createGroup(GroupInfo groupInfo, IGroup parentGroup) Creates new security group based on provided group specification and parent group.

Method parameters in com.ibm.openpages.api.service with type arguments of type IGroup

Modifier and Type	Method and Description
IUser	ISecurityService.createUser(UserInfo userInfo, java.util.List<IGroup> groups) Creates user based on provided specification and a list of groups for membership assignment.
void	ISecurityService.deleteGroups(java.util.List<IGroup> groups) Deletes specified groups from OpenPages security system.