Class actuate.reportexplorer.PrivilegeFilter
Description
The PrivilegeFilter class contains a set of user-identifying information and access rights that are associated with identified users. PrivilegeFilter represents a JavaScript version of com.actuate.schemas.PrivilegeFilter.
Constructor
Syntax
actuate.reportexplorer.PrivilegeFilter( )
Constructs a new PrivilegeFilter object.
Function summary
Table 7‑50 lists actuate.reportexplorer.PrivilegeFilter functions.
Table 7‑50 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
getAccessRights
Syntax
string privilegeFilter.getAccessRights( )
Gets the repository access rights value for this PrivilegeFilter.
Returns
String. Repository access rights.
Example
To halt a script if the access rights of a PrivilegeFilter pfilter are null, use code similar to the following:
if(pfilter.getAccessRights( ) == null){ return;}
getGrantedRoleId
Syntax
string PrivilegeFilter.getGrantedRoleId( )
Gets the grantedRoleId value for this PrivilegeFilter.
Returns
String. A role ID.
Example
To retrieve the granted role ID for a PrivilegeFilter pfilter, use code similar to the following:
var roleid = pfilter.getGrantedRoleId( );
getGrantedRoleName
Syntax
string PrivilegeFilter.getGrantedRoleName( )
Gets the grantedRoleName value for this PrivilegeFilter.
Returns
String. A role name.
Example
To retrieve the granted role name for a PrivilegeFilter pfilter, use code similar to the following:
var rolename = pfilter.getGrantedRoleName( );
getGrantedUserId
Syntax
string PrivilegeFilter.getGrantedUserId( )
Gets the grantedUserId value for this PrivilegeFilter.
Returns
String. A user ID.
Example
To retrieve the granted user ID for a PrivilegeFilter pfilter, use code similar to the following:
var userid = pfilter.getGrantedUserId( );
getGrantedUserName
Syntax
string PrivilegeFilter.getGrantedUserName( )
Gets the grantedUserName value for this PrivilegeFilter.
Returns
String. A user name.
Example
To retrieve the granted user name for a PrivilegeFilter pfilter, use code similar to the following:
var username = pfilter.getGrantedUserName( );
setAccessRights
Syntax
void PrivilegeFilter.setAccessRights(string accessRights)
Sets the repository access rights value for this PrivilegeFilter.
Parameter
accessRights
String. The access rights.
Example
To copy the set of access rights from PrivilegeFilter pfilter1 to PrivilegeFilter pfilter2, use code similar to the following:
pfilter2.setAccessRights(pfilter1.getAccessRights( ));
setGrantedRoleId
Syntax
void PrivilegeFilter.setGrantedRoleId(string grantedRoleId)
Sets the grantedRoleId of the column for this PrivilegeFilter.
Parameter
grantedRoleId
String. A role ID.
Example
To set the granted role ID of the PrivilegeFilter pfilter to All, use code similar to the following:
pfilter.setGrantedRoleId("All");
setGrantedRoleName
Syntax
void PrivilegeFilter.setGrantedRoleName(string grantedRoleName)
Sets the grantedRoleName value for this PrivilegeFilter.
Parameter
grantedRoleName
String. A role name.
Example
To set the granted role name of the PrivilegeFilter pfilter to Everyone, use code similar to the following:
pfilter.setGrantedRoleName("Everyone");
setGrantedUserId
Syntax
void PrivilegeFilter.setGrantedUserId(string grantedUserId)
Sets the grantedUserId value for this PrivilegeFilter.
Parameter
grantedUserId
String. A user ID.
Example
To set the granted user ID of the PrivilegeFilter pfilter to administrator, use code similar to the following:
pfilter.setGrantedRoleId("Administrator");
setGrantedUserName
Syntax
void PrivilegeFilter.setGrantedUserName(string grantedUserName)
Sets the grantedUserName value for this PrivilegeFilter.
Parameter
grantedUserName
String. A user name.
Example
To set the granted user name of the PrivilegeFilter pfilter to administrator, use code similar to the following:
pfilter.setGrantedRoleId("Administrator");