public class

MetadataSearchTask

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

Class Overview

This is the task for metadata searching. This task assumes it works against a folder bean. It will add searchXML as a non-required task parameter. During restoring state stage, it will get the request parameter "searchXML" and use it to restore the search object in the folder bean. This is the only extra responsibility taken by this provider.

Summary

Constants
String PARAM_NAME_QUICKSEARCH
String PARAM_NAME_SEARCHFIELDS
String PARAM_NAME_SEARCH_XML
[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
MetadataSearchTask()
Protected Methods
void collectData(BeanTaskRequestContext btrContext)
This method calls the 'collectData' method on the WebBean instance.
void handleEvent(BeanTaskRequestContext bsrContext)
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

Constants

public static final String PARAM_NAME_QUICKSEARCH

Constant Value: "quickSearch"

public static final String PARAM_NAME_SEARCHFIELDS

Constant Value: "fields"

public static final String PARAM_NAME_SEARCH_XML

Constant Value: "searchXML"

Public Constructors

public MetadataSearchTask ()

Protected Methods

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