Folder Object

The Folder object represents a workspace folder and provides the following types of methods:
  • Property methods
  • Subfolder methods
  • Mastership methods
  • Permission methods
  • Permission change methods
  • Refresh

You work with existing Folder objects by calling a method of the Workspace object, such as GetPublicFolder.

The permission methods of the Folder object all work with collections of access permissions as represented by a Permissions object. A user is only able to see Permission objects that might apply to them, which is any permission granted to one of the user's groups. Users with the Security Administrator privilege can see all Permission objects. These methods only return the set of permissions visible to the current user.

A user with the "All Users/Groups Visible" privilege is able to see permissions for all groups, but can add, change, or remove permissions only for their own groups.

Some of the methods are defined to return a set of permissions for a specified group or user. When the "ForUser" form is used, the result contains the permissions that apply for any of the user's groups.

The permission methods distinguish between applied and effective access permissions. An applied permission is one associated with a certain folder. An effective permission is an access permission that has an effect on a folder for the current user. An effective permission may actually be inherited from a permission that is applied to a parent folder. When an effective permission is returned, it identifies the actual folder it is applied to.

The model for changing permissions is to make one or more calls to change permissions on a folder and then either commit or revert those changes. The changes have an immediate effect in the current session, but are not written to the database until they are committed. This allows the client to examine the effect of making a change before committing it for all other users.