public class

ModifyPrivilegesTask

extends BaseUserEntityBeanTask
java.lang.Object
   ↳ com.microstrategy.web.tasks.AbstractBaseTask
     ↳ com.microstrategy.web.app.tasks.AbstractAppTask
       ↳ com.microstrategy.web.app.tasks.WebComponentTask
         ↳ com.microstrategy.web.app.tasks.BeanTask
           ↳ com.microstrategy.web.app.tasks.BaseUserEntityBeanTask
             ↳ com.microstrategy.web.app.tasks.ModifyPrivilegesTask

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected TaskParameterMetadata privilegeCategoriesParam The privilege category of the user or group.
protected TaskParameterMetadata privilegeIDParam The privilege id of the user or group.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
ModifyPrivilegesTask()
Protected Methods
void handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.
void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.tasks.BaseUserEntityBeanTask
From class com.microstrategy.web.app.tasks.BeanTask
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.app.tasks.AbstractAppTask
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Fields

protected TaskParameterMetadata privilegeCategoriesParam

The privilege category of the user or group.
This parameter format is as follows: "Ctype_privCat1ALL^Ctype_privCat2ALL", for the privilege category value, see com.microstrategy.webapi.EnumDSSXMLPrivilegeCategoryTypes Ctype_ is a required prefix for specifying categories. For example, specifying the Web Reporter privilege (DssXmlPrivilegeCategoryWebReporter = 1 ) would represent “Ctype_1ALL”. For testing this task in the Task Administrator or Task Developer page, copy the following delimiter to use to test: .

protected TaskParameterMetadata privilegeIDParam

The privilege id of the user or group.
This parameter format is as follows: "privId1^privId2^privId3", for the privId value, see com.microstrategy.webapi.EnumDSSXMLPrivilegeTypes

Public Constructors

public ModifyPrivilegesTask ()

Protected Methods

protected void handleEvent (BeanTaskRequestContext btrContext)

This method instructs the WebBean to handle the event. It is called from processRequest(TaskRequestContext, TaskOutput).

Parameters
btrContext The BeanTaskRequestContext that contains the WebBean instance.
Throws
TaskException

protected void registerParameterMetadata (TaskParameterMetadata parameterMetadata)

Registers a specific Task parameter metadata. This method is called by registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.

Parameters
parameterMetadata The TaskParameterMetadata object being saved.