com.crystaldecisions.sdk.occa.infostore
Interface IPrincipalBase

All Known Subinterfaces:

IEffectivePrincipal, IExplicitPrincipal

public interface IPrincipalBase

This interface defines the base methods for a security principal (user, group)

Method Summary

int	getID() Returns the principal's ID.
java.lang.String	getName() Returns the name of the principal.
boolean	isInheritFolders() Returns true if security info can be inherited from parent folders, and false otherwise.
boolean	isInheritGroups() Returns true if security info can be inherited from parent user groups, and false otherwise.

Method Detail

getID

int getID()

Returns the principal's ID.

Returns:

The int value of the principal's ID.

getName

java.lang.String getName()

Returns the name of the principal.

Returns:

A String containing the name of the principal.

isInheritGroups

boolean isInheritGroups()

Returns true if security info can be inherited from parent user groups, and false otherwise.

Returns:

A boolean that specifies whether this object can inherit security info from parent user groups. true enables inheritance while false disables it.

isInheritFolders

boolean isInheritFolders()

Returns true if security info can be inherited from parent folders, and false otherwise.

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

Returns:

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