Package com.microstrategy.web.app.tasks
Class ModifyPrivilegesTask
- java.lang.Object
-
- All Implemented Interfaces:
Task
public class ModifyPrivilegesTask extends BaseUserEntityBeanTask
-
-
Field Summary
Fields Modifier and Type Field Description protected TaskParameterMetadata
privilegeCategoriesParam
The privilege category of the user or group.protected TaskParameterMetadata
privilegeIDParam
The privilege id of the user or group.-
Fields inherited from class com.microstrategy.web.app.tasks.WebComponentTask
FP_NAME_CONTENT_TYPE, initializationErrorMessage
-
Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask
compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam
-
-
Constructor Summary
Constructors Constructor Description ModifyPrivilegesTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.protected void
registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.-
Methods inherited from class com.microstrategy.web.app.tasks.BaseUserEntityBeanTask
prepareBean
-
Methods inherited from class com.microstrategy.web.app.tasks.BeanTask
createWebBean
-
Methods inherited from class com.microstrategy.web.app.tasks.WebComponentTask
addTransform, collectData, createUntypedWebComponent, destroy, generatesContent, getBeanInfo, getStyleName, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerTaskMetadata, requiresIServerSession, restoreBeanState, serializeResult, setBeanContext, setBeanInfo, setBeanName, setBeanProperties, setBeanSession, setSuccessfullyInitialized, setTaskID, transformBean
-
Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask
getDescriptor
-
Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask
addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType
-
-
-
-
Field Detail
-
privilegeIDParam
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
-
privilegeCategoriesParam
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: .
-
-
Method Detail
-
registerParameterMetadata
protected void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Description copied from class:WebComponentTask
Registers a specific Task parameter metadata. This method is called byWebComponentTask.registerTaskMetadata(TaskMetadata)
. It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.- Overrides:
registerParameterMetadata
in classBaseUserEntityBeanTask
- Parameters:
parameterMetadata
- The TaskParameterMetadata object being saved.
-
handleEvent
protected void handleEvent(BeanTaskRequestContext btrContext) throws TaskException
Description copied from class:WebComponentTask
This method instructs the WebBean to handle the event. It is called fromWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
.- Overrides:
handleEvent
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext that contains the WebBean instance.- Throws:
TaskException
- If something fails in the process of handling the event.TaskRequestMalformedException
- If there was an exception raised while handling the event.
-
-