com.crystaldecisions.sdk.occa.infostore
Interface IExplicitPrincipals

All Superinterfaces:

IPrincipalsBase

public interface IExplicitPrincipals
extends IPrincipalsBase

This interface represents a collection that contains the object principals (users and groups) that have explicit rights, limits, or roles on a particular object.

Method Summary

IExplicitPrincipal	add(int id) Adds a new principal to the collection.
IExplicitPrincipal	get(int id) Returns the principal with the given ID.
void	remove(int id) Removes a principal from the collection.
void	setGlobalInheritFolders(boolean inheritFolders) Sets whether this object can inherit security info from parent folders.

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IPrincipalsBase

isGlobalInheritFolders, iterator, size

Method Detail

add

IExplicitPrincipal add(int id)

Adds a new principal to the collection.

Parameters:

id - The ID of the new principal to add.

Returns:

The newly created principal.

get

IExplicitPrincipal get(int id)

Returns the principal with the given ID.

Note: Ensure that the IExplicitPrinicipal object is added to the collection before committing changes to the CMS repository. Otherwise the principal's new rights or limits will not be enforced.

Parameters:

id - The principal ID.

Returns:

The principal specified by id, or null if no such principal exists.

remove

void remove(int id)
            throws SDKException

Removes a principal from the collection.

Parameters:

id - The ID of the principal to remove.

Throws:

SDKException

setGlobalInheritFolders

void setGlobalInheritFolders(boolean inheritFolders)

Sets whether this object can inherit security info from parent folders. If true, rights can be inherited from parent folders, and false if folder inheritance is turned off for all principals.

Parameters:

inheritFolders - A boolean that specifies whether security info can be inherited from parent folders. true enables inheritance while false disables it for all principals. When this flag is set, all folder inheritance will be turned off regardless of the folder inheritance set on each principal.