com.crystaldecisions.sdk.occa.infostore
Interface IRole

public interface IRole

This interface defines roles that can be assigned to users. A role or access mode is a predefined set of object rights that allows you to set common object security levels quickly. They are designed to cover the most common cases of security rights settings. It is recommended that you start by using roles, and then apply more granular rights if necessary. The rights that are listed for each role are always granted to the principal, and never denied. See the "Appendix A: Object Rights and Access Levels" in the BusinessObjects Enterprise Administrator's Guide for a list of the granular rights granted for each role.

Field Summary

static IRole	ADVANCED This constant value specifies that the principal has individually set rights.
static IRole[]	ALL_ROLES This constant value is an array of Role objects that contains a role object corresponding to each of the constant predefined role values.
static IRole	FULL_CONTROL This constant value specifies that the principal has complete rights over the object.
static IRole	NO_ACCESS This constant value specifies that the principal has no access to the object.
static IRole	SCHEDULE This constant value specifies that the principal can view folders and reports.
static IRole	VIEW This constant value specifies that the principal can view folders and reports.
static IRole	VIEW_ON_DEMAND This constant value specifies that the principal can view folders and reports.

Method Summary

void	addRights(int[] rights) Deprecated. This method has been deprecated.
java.lang.String	getDescription(java.util.Locale locale) Returns the display name of the role.
IRightID[]	toArray() Returns an array of IRightID's.

Field Detail

ADVANCED

public static final IRole ADVANCED

This constant value specifies that the principal has individually set rights.

NO_ACCESS

public static final IRole NO_ACCESS

This constant value specifies that the principal has no access to the object.

VIEW

public static final IRole VIEW

This constant value specifies that the principal can view folders and reports. For reports, this means that the user can view the latest instance and view the history of the report.

VIEW_ON_DEMAND

public static final IRole VIEW_ON_DEMAND

This constant value specifies that the principal can view folders and reports. In addition, to rights provided by the Schedule access mode, the user gains the right to refresh report objects and instances against their data source.

SCHEDULE

public static final IRole SCHEDULE

This constant value specifies that the principal can view folders and reports. In addition, the user or group can set parameters, set database logon information, and generate Freeport instances by scheduling reports to run against the specified data source once or on a recurring basis.

FULL_CONTROL

public static final IRole FULL_CONTROL

This constant value specifies that the principal has complete rights over the object. In addition to everything included with the Schedule right, the Full Control right allows users to schedule, run, and set default parameters for reports. Full Control is the only right that allows users to delete objects (folders, reports, instances).

ALL_ROLES

public static final IRole[] ALL_ROLES

This constant value is an array of Role objects that contains a role object corresponding to each of the constant predefined role values.

Method Detail

addRights

public void addRights(int[] rights)

Deprecated. This method has been deprecated.

This method has been deprecated.

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Returns the display name of the role.

Parameters:

locale - The Locale object specifying the locale-specific display information to be used.

Returns:

Returns a string containing the display name of the role.

toArray

public IRightID[] toArray()

Returns an array of IRightID's.

Returns:

Return the rights for this role as an array of IRightIDs.