Class actuate.reportexplorer.PrivilegeFilter

Description

The PrivilegeFilter class contains a set of user-identifying information and access rights that are associated with the identified users.

Constructor

Syntax

actuate.reportexplorer.PrivilegeFilter( )

Constructs a new PrivilegeFilter object.

Function summary

Table 4-39 lists actuate.reportexplorer.PrivilegeFilter functions.

Table 4-39  actuate.reportexplorer.PrivilegeFilter functions 

Function	Description
getAccessRights( )	Gets the accessRights value for this PrivilegeFilter.
getGrantedRoleId( )	Gets the grantedRoleId value for this PrivilegeFilter.
getGrantedRoleName( )	Gets the grantedRoleName value for this PrivilegeFilter.
getGrantedUserId( )	Gets the grantedUserId value for this PrivilegeFilter.
getGrantedUserName( )	Gets the grantedUserName value for this PrivilegeFilter.
setAccessRights( )	Sets the accessRights value for this PrivilegeFilter.
setGrantedRoleId( )	Sets the grantedRoleId value for this PrivilegeFilter.
setGrantedRoleName( )	Sets the grantedRoleName value for this PrivilegeFilter.
setGrantedUserId( )	Sets the grantedUserId value for this PrivilegeFilter.
setGrantedUserName( )	Sets the grantedUserName value for this PrivilegeFilter.

actuate.reportexplorer.PrivilegeFilter.getAccess
Rights

Syntax

string privilegeFilter.getAccessRights( )

Gets the repository access rights value for this PrivilegeFilter.

Returns

String.

Example

To halt a script if a PrivilegeFilter pfilter’s access rights are null, use code similar to the following:

if(pfilter.getAccessRights( ) == null){ return;}

actuate.reportexplorer.PrivilegeFilter.getGranted
RoleId

Syntax

string PrivilegeFilter.getGrantedRoleId( )

Gets the grantedRoleId value for this PrivilegeFilter.

Returns

String.

Example

To retrieve the granted role id for a PrivilegeFilter pfilter, use code similar to the following:

var roleid = pfilter.getGrantedRoleId( );

actuate.reportexplorer.PrivilegeFilter.getGrantedRoleName

Syntax

string PrivilegeFilter.getGrantedRoleName( )

Gets the grantedRoleName value for this PrivilegeFilter.

Returns

String.

Example

To retrieve the granted role name for a PrivilegeFilter pfilter, use code similar to the following:

var rolename = pfilter.getGrantedRoleName( );

actuate.reportexplorer.PrivilegeFilter.getGranted
UserId

Syntax

string PrivilegeFilter.getGrantedUserId( )

Gets the grantedUserId value for this PrivilegeFilter.

Returns

String.

Example

To retrieve the granted user id for a PrivilegeFilter pfilter, use code similar to the following:

var userid = pfilter.getGrantedUserId( );

actuate.reportexplorer.PrivilegeFilter.getGrantedUserName

Syntax

string PrivilegeFilter.getGrantedUserName( )

Gets the grantedUserName value for this PrivilegeFilter.

Returns

String.

Example

To retrieve the granted user name for a PrivilegeFilter pfilter, use code similar to the following:

var username = pfilter.getGrantedUserName( );

actuate.reportexplorer.PrivilegeFilter.setAccess
Rights

Syntax

void PrivilegeFilter.setAccessRights(string accessRights)

Sets the repository access rights value for this PrivilegeFilter.

Parameters

accessRights

String.

Example

To copy the set of access rights from PrivilegeFilter pfilter1 to PrivilegeFilter pfilter2, use code similar to the following:

pfilter2.setAccessRights(pfilter1.getAccessRights( ));

actuate.reportexplorer.PrivilegeFilter.setGranted
RoleId

Syntax

void PrivilegeFilter.setGrantedRoleId(string grantedRoleId)

Sets the grantedRoleId of the column for this PrivilegeFilter.

Parameters

grantedRoleId

String.

Example

To set the granted role id of the PrivilegeFilter pfilter to All, use code similar to the following:

pfilter.setGrantedRoleId("All");

actuate.reportexplorer.PrivilegeFilter.setGrantedRoleName

Syntax

void PrivilegeFilter.setGrantedRoleName(string grantedRoleName)

Sets the grantedRoleName value for this PrivilegeFilter.

Parameters

grantedRoleName

String.

Example

To set the granted role id of the PrivilegeFilter pfilter to Everyone, use code similar to the following:

pfilter.setGrantedRoleName("Everyone");

actuate.reportexplorer.PrivilegeFilter.setGranted
UserId

Syntax

void PrivilegeFilter.setGrantedUserId(string grantedUserId)

Sets the grantedUserId value for this PrivilegeFilter.

Parameters

grantedUserId

String.

Example

To set the granted user id of the PrivilegeFilter pfilter to administrator, use code similar to the following:

pfilter.setGrantedRoleId("Administrator");

actuate.reportexplorer.PrivilegeFilter.setGrantedUserName

Syntax

void PrivilegeFilter.setGrantedUserName(string grantedUserName)

Sets the grantedUserName value for this PrivilegeFilter.

Parameters

grantedUserName

String.

Example

To set the granted user name of the PrivilegeFilter pfilter to administrator, use code similar to the following:

pfilter.setGrantedRoleId("Administrator");

(c) Copyright Actuate Corporation 2011