public class

RWSaveSegmentTask

extends AbstractSaveTask
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.AbstractSaveTask
             ↳ com.microstrategy.web.app.tasks.RWSaveSegmentTask

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.tasks.AbstractSaveTask
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
[Expand]
Inherited Fields
From class com.microstrategy.web.app.tasks.AbstractSaveTask
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
RWSaveSegmentTask()
Public Methods
void processRequest(TaskRequestContext context, TaskOutput taskOutput)
Process the incoming request.
Protected Methods
void prepareBean(BeanTaskRequestContext btrContext)
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.AbstractSaveTask
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

Public Constructors

public RWSaveSegmentTask ()

Public Methods

public void processRequest (TaskRequestContext context, TaskOutput taskOutput)

Process the incoming request. This method proceeds through the following sequence:

  1. Check for all required parameters. (calls checkForRequiredParameters(RequestKeys))
  2. Prepare the RequestKeys for use. (calls prepareRequestKeys(BeanTaskRequestContext))
  3. Prepare the WebBean for use. (calls prepareBean(BeanTaskRequestContext))
  4. Handle the event. (calls handleEvent(BeanTaskRequestContext))
  5. Collect data for the request. (calls collectData(BeanTaskRequestContext))
  6. Serialize the results into the supplied TaskOutput. (calls serializeResult(BeanTaskRequestContext, TaskOutput))

Parameters
context The TaskRequestContext object that contains information specific to this request.
taskOutput The TaskOutput object to serialize the results into.
Throws
TaskException

Protected Methods

protected void prepareBean (BeanTaskRequestContext btrContext)

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
btrContext 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.