## Uses of Interface
com.ibm.openpages.api.resource.IFolder

- Packages that use IFolder
  Package | Description
  --- | ---
  com.ibm.openpages.api.resource | Provides interfaces to work with the OpenPages content data: folders, GRC objects and document attachments.
  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 IFolder in com.ibm.openpages.api.resource

    Methods in com.ibm.openpages.api.resource that return IFolder
    Modifier and Type | Method and Description
    --- | ---
    `IFolder` | IResourceFactory.`createFolder(java.lang.String name, IFolder parentFolder)` Creates a new instance of the IFolder interface to be persisted in the system.
    `IFolder` | IResource.`getParentFolder()` Returns the parent folder for this resource, if it exists; otherwise null.

    Methods in com.ibm.openpages.api.resource with parameters of type IFolder
    Modifier and Type | Method and Description
    --- | ---
    `IFolder` | IResourceFactory.`createFolder(java.lang.String name, IFolder parentFolder)` Creates a new instance of the IFolder interface to be persisted in the system.
    `void` | IResource.`setParentFolder(IFolder parentFolder)` Sets the parent folder using the supplied folder.

  - ### Uses of IFolder in com.ibm.openpages.api.security

    Methods in com.ibm.openpages.api.security that return IFolder
    Modifier and Type | Method and Description
    --- | ---
    `IFolder` | IRoleAssignment.`getFolder()` Returns the folder that is the scope of the object permissions assignment.
    `IFolder` | IObjectPermission.`getRootFolder()` Returns root folder associated to permission.

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

    Methods in com.ibm.openpages.api.service that return IFolder
    Modifier and Type | Method and Description
    --- | ---
    `IFolder` | IResourceService.`getFolder(Id id)` Get a Folder object by Id for the current period.
    `IFolder` | IResourceService.`getFolder(Id id, FolderFilter filter)` Get a Folder object by Id.
    `IFolder` | IResourceService.`getFolder(java.lang.String path)` Get a Folder object by path for the current period.
    `IFolder` | IResourceService.`getFolder(java.lang.String path, FolderFilter filter)` Get a Folder object by path.

    Methods in com.ibm.openpages.api.service with parameters of type IFolder
    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 IFolder
    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.