public class

BlockLoaderTask

extends WebComponentTask
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.BlockLoaderTask

Class Overview

This class provides some basic functionality for loading Blocks and in the case of the JavaScript UI Library ("JUIL"), the ability to serialize a set of client-side layout files to JavaScript.

Summary

Constants
String TASK_PARAM_NAME_BLOCKNAME
String TASK_PARAM_NAME_JUIL The name of the Task parameter that identifies whether this Task is invoked for the JavaScript UI Library ("JUIL").
String TASK_PARAM_NAME_STYLENAME
[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
BlockLoaderTask()
Creates a new BlockLoaderTask object.
Protected Methods
void checkForRequiredParameters(RequestKeys requestKeys)
Checks whether all required parameters are present or not.
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.
void transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method wraps a call to transform().
[Expand]
Inherited Methods
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

Constants

public static final String TASK_PARAM_NAME_BLOCKNAME

Constant Value: "blockName"

public static final String TASK_PARAM_NAME_JUIL

The name of the Task parameter that identifies whether this Task is invoked for the JavaScript UI Library ("JUIL").

Constant Value: "juil"

public static final String TASK_PARAM_NAME_STYLENAME

Constant Value: "styleName"

Public Constructors

public BlockLoaderTask ()

Creates a new BlockLoaderTask object. All BlockLoaderTasks have an implicit "session state" (as BeanTasks) parameter (see addSessionStateParam(boolean, String)).

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.

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

protected void transformBean (BeanTaskRequestContext btrContext, TaskOutput taskOutput)

This method wraps a call to transform(). It is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method and simply calls the 'transform' method.

Parameters
btrContext The BeanTaskRequestContext object.
taskOutput The TaskOutput instance to generate into.