public class

GetRWGraphImageTask

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

Class Overview

This Task retrieves the binary image data for a graph node in a Report Writing document.

Summary

[Expand]
Inherited Constants
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.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
GetRWGraphImageTask()
Protected Methods
void checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.
void collectData(BeanTaskRequestContext btrContext)
This method calls the 'collectData' method on the WebBean instance.
WebGraph getWebGraph(BeanTaskRequestContext btrContext)
void handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.
void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.
void serializeResult(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method attempts to serialize the results to the supplied TaskOutput object.
[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

Public Constructors

public GetRWGraphImageTask ()

Protected Methods

protected void checkForRequiredParameters (RequestKeys requestKeys)

Checks whether all required parameters are present or not.

Parameters
requestKeys The RequestKeys object that contains all parameters.
Throws
TaskRequestMalformedException

protected void collectData (BeanTaskRequestContext btrContext)

This method calls the 'collectData' method on the WebBean instance. This method is called by processRequest(TaskRequestContext, TaskOutput).

Parameters
btrContext The BeanTaskRequestContext object.
Throws
TaskException

protected WebGraph getWebGraph (BeanTaskRequestContext btrContext)

Throws
TaskException

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.

protected void serializeResult (BeanTaskRequestContext btrContext, TaskOutput taskOutput)

This method attempts to serialize the results to the supplied TaskOutput object. This method is called by processRequest(TaskRequestContext, TaskOutput) and in turn does the following:

  1. Add the Transform. If there is no transform specified, an empty MarkupOutput is returned. (calls addTransform(BeanTaskRequestContext))
  2. Override any actual parameters specified in the Bean Task XML. (calls overrideActualParameters(BeanTaskRequestContext, TransformInstance))
  3. Transforms the WebBean using the Transform. (calls transformBean(BeanTaskRequestContext, TaskOutput))

Parameters
btrContext The BeanTaskRequestContext object.
taskOutput The TaskOutput object to populate.
Throws
TaskException