public class

ModifyChildrenTask

extends BeanTask
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.ModifyChildrenTask

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Fields
protected TaskParameterMetadata childrenParam The children of the user group to modify.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
ModifyChildrenTask()
Protected Methods
void handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.
void prepareBean(BeanTaskRequestContext bsrContext)
This method prepares the WebBean for execution.
void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.
[Expand]
Inherited Methods
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 childrenParam

The children of the user group to modify. It includes the information about children id and children type.
This parameter format is as follows: "childrenID1childrenType^childredID2childrenType". For testing this task in the Task Administrator or Task Developer page, copy the following delimiter to use to test: .
For the childrenType value, see com.microstrategy.webapi.EnumDSSXMLObjectSubTypes

Public Constructors

public ModifyChildrenTask ()

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 prepareBean (BeanTaskRequestContext bsrContext)

This method prepares the WebBean for execution. It is called by the processRequest(TaskRequestContext, TaskOutput) method. It performs the following actions:

  1. Creates a new WebBean instance and adds it to the context. (calls createWebBean(BeanTaskRequestContext))
  2. Sets any bean properties. (calls setBeanProperties(BeanTaskRequestContext))
  3. Restores any bean state. (calls restoreBeanState(BeanTaskRequestContext))

Parameters
bsrContext The BeanTaskRequestContext to use.
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.