com.crystaldecisions.sdk.occa.infostore
Interface ISecurityPrincipal

public interface ISecurityPrincipal

This interface defines a principal and the security info that applies to it on a given object.

Method Summary

int	getID() Returns the ID of the principal (user or group).
ISecurityLimitAdmin[]	getLimits() Returns array of security limits that apply to the principal on current object
java.lang.String	getName() Name of the principal.
ISecurityRightAdmin[]	getRights() Returns array of security rights that apply to the principal on current object
ISecurityRoleAdmin[]	getRoles() Returns array of security roles that apply to the principal on current object
boolean	isAdvanced() Returns true if this principal effectively has some granular rights set that are not from a role definition.
boolean	isInherited() Flag indicating whether all security info of the principal are inherited
boolean	isInheritFolders() Flag indicating whether the principal inherits security info from folder hierarchy.
boolean	isInheritGroups() Flag indicating whether the principal inherits security info from user group hierarchy.

Method Detail

getID

int getID()

Returns the ID of the principal (user or group). A principal ID of 0 indicates the global setting of folder inheritance on an object. For this principal, only isInheritedFolders is in effect.

Returns:

the ID of the principal

getName

java.lang.String getName()

Name of the principal. For prinipal 0, the name is empty. Refer to getID() documentation for more detail.

Returns:

Name of the principal

isInheritFolders

boolean isInheritFolders()

Flag indicating whether the principal inherits security info from folder hierarchy. If the principal has an ID of 0, that means the folder inheritance is turned off on all users.

Returns:

Boolean indicating whether the principal inherits security info from folder hierarchy. true indicates the principal inherits security from curent object's folders; false otherwise.

isInheritGroups

boolean isInheritGroups()

Flag indicating whether the principal inherits security info from user group hierarchy.

Returns:

Boolean indicating whether the principal inherits security info from user group hierarchy. true indicates the principal inherits security from principal's parent groups; false otherwise.

getRights

ISecurityRightAdmin[] getRights()

Returns array of security rights that apply to the principal on current object

Returns:

Array of security rights that apply to the principal on current object

getLimits

ISecurityLimitAdmin[] getLimits()

Returns array of security limits that apply to the principal on current object

Returns:

Array of security limits that apply to the principal on current object

getRoles

ISecurityRoleAdmin[] getRoles()

Returns array of security roles that apply to the principal on current object

Returns:

Array of security roles that apply to the principal on current object

isInherited

boolean isInherited()

Flag indicating whether all security info of the principal are inherited

Returns:

Boolean indicating whether all security info of the principal are inherited

isAdvanced

boolean isAdvanced()

Returns true if this principal effectively has some granular rights set that are not from a role definition.

Returns:

true if this principal effectively has some granular rights set that are not from a role definition.