public class

FolderBrowseTask

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

Class Overview

This class implements a Folder Browsing Task.

Summary

Constants
String TASK_PARAM_NAME_JUIL The name of the Task parameter that identifies whether this Task is invoked for the Javascript UI Library ("JUIL").
[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
FolderBrowseTask()
Protected Methods
void collectData(BeanTaskRequestContext bsrContext)
This method calls the 'collectData' method on the WebBean instance.
void handleEvent(BeanTaskRequestContext bsrContext)
This method instructs the WebBean to handle the event.
void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.
void transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method wraps a call to transform().
[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

Constants

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 Constructors

public FolderBrowseTask ()

Protected Methods

protected void collectData (BeanTaskRequestContext bsrContext)

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

Parameters
bsrContext The BeanTaskRequestContext object.
Throws
TaskException

protected void handleEvent (BeanTaskRequestContext bsrContext)

This method instructs the WebBean to handle the event. It is called from processRequest(TaskRequestContext, TaskOutput).

Parameters
bsrContext 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 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.