## Uses of Interface
com.ibm.openpages.api.security.IRoleTemplate

- Packages that use IRoleTemplate
  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 IRoleTemplate in com.ibm.openpages.api.security

    Methods in com.ibm.openpages.api.security that return IRoleTemplate
    Modifier and Type | Method and Description
    --- | ---
    `IRoleTemplate` | IRoleAssignment.`getRoleTemplate()` Returns the role template which permissions get assigned.

    Methods in com.ibm.openpages.api.security that return types with arguments of type IRoleTemplate
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<IRoleTemplate>` | IUser.`getRoleTemplates()` Returns all roles for a user.
    `java.util.Iterator<IRoleTemplate>` | IGroup.`getRoleTemplates()` Returns an iterator over all roles assigned with this group.

  - ### Uses of IRoleTemplate in com.ibm.openpages.api.service

    Methods in com.ibm.openpages.api.service that return IRoleTemplate
    Modifier and Type | Method and Description
    --- | ---
    `IRoleTemplate` | ISecurityService.`getRoleTemplate(Id id)` Retrieves role template by Id.
    `IRoleTemplate` | ISecurityService.`getRoleTemplate(java.lang.String name)` Retrieves role template by name.

    Methods in com.ibm.openpages.api.service that return types with arguments of type IRoleTemplate
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<IRoleTemplate>` | ISecurityService.`getRoleTemplates(boolean includesLockedTemplates, boolean includesDisabledTemplates)` Retrieves role templates based on the specified criteria.

    Methods in com.ibm.openpages.api.service with parameters of type IRoleTemplate
    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.`assignRole(IUser user, IRoleTemplate roleTemplate, IFolder folder)` Assigns role to specified user for the given folder.
    `java.util.Iterator<IRoleAssignment>` | ISecurityService.`getRoleAssignments(ISecurityPrincipal userOrGroup, IRoleTemplate roleTemplate, IFolder folder)` Returns an iterator over all role assignments effective in the user or group

    Method parameters in com.ibm.openpages.api.service with type arguments of type IRoleTemplate
    Modifier and Type | Method and Description
    --- | ---
    `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.
    `void` | ISecurityService.`assignRoles(IUser user, java.util.List<IRoleTemplate> roleTemplates, java.util.List<IFolder> folders)` Assigns each of the roles in the roleTemplates list to a specified user in each of the folders.

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2022. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.