com.crystaldecisions.sdk.occa.infostore
Interface IExplicitPrincipal

All Superinterfaces:

IPrincipalBase

public interface IExplicitPrincipal
extends IPrincipalBase

This interface defines an object principal (a user or a group) with explicit rights assigned to a particular object. Use this interface to access and modify a principal's explicit access controls on an object.

Method Summary

IExplicitLimits	getLimits() Returns a collection of limits that are assigned to the principal.
IExplicitRights	getRights() Returns the collection of rights that are assigned to the principal.
IExplicitRoles	getRoles() Returns a collection of roles that are assigned to the principal.
void	setInheritFolders(boolean inheritFolders) Sets whether this object can inherit security info from parent folders.
void	setInheritGroups(boolean inheritGroups) Sets whether this object can inherit security info from parent user groups.

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

getID, getName, isInheritFolders, isInheritGroups

Method Detail

getRights

IExplicitRights getRights()

Returns the collection of rights that are assigned to the principal. This may be different from the effective rights.

Returns:

An IExplicitRights object of specific rights that are explicitly assigned to the principal.

getLimits

IExplicitLimits getLimits()

Returns a collection of limits that are assigned to the principal.

Returns:

An IExplicitLimits object that contains the limits assigned to the principal.

getRoles

IExplicitRoles getRoles()

Returns a collection of roles that are assigned to the principal.

Returns:

An IExplicitRoles object that contains the roles assigned to the principal.

setInheritGroups

void setInheritGroups(boolean inheritGroups)

Sets whether this object can inherit security info from parent user groups. If true, rights can be inherited from parent user groups, otherwise false.

Parameters:

inheritGroups - A boolean that specifies whether security info can be inherited from parent user groups. true enables inheritance while false disables

setInheritFolders

void setInheritFolders(boolean inheritFolders)

Sets whether this object can inherit security info from parent folders. If true, rights can be inherited from parent folders, otherwise false.

This flag will be overriden by the global folder inheritance flag specified on IExplicitPrincipals if the global folder inheritance is turned off.

Parameters:

inheritFolders - A boolean that specifies whether security info can be inherited from parent folders. true enables inheritance while false disables it. This flag can only be set for explicit principal.