Package com.microstrategy.web.app.tasks
Class MetadataSearchTask
- 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
-
- All Implemented Interfaces:
Task
public class MetadataSearchTask extends BeanTask
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.- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAM_NAME_QUICKSEARCH
static java.lang.String
PARAM_NAME_SEARCH_XML
static java.lang.String
PARAM_NAME_SEARCHFIELDS
-
Fields inherited from class com.microstrategy.web.app.tasks.WebComponentTask
FP_NAME_CONTENT_TYPE, initializationErrorMessage
-
Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask
compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam
-
-
Constructor Summary
Constructors Constructor Description MetadataSearchTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
collectData(BeanTaskRequestContext btrContext)
This method calls the 'collectData' method on the WebBean instance.protected void
handleEvent(BeanTaskRequestContext bsrContext)
This method instructs the WebBean to handle the event.protected void
prepareBean(BeanTaskRequestContext bsrContext)
This method prepares the WebBean for execution.protected void
registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.-
Methods inherited from class com.microstrategy.web.app.tasks.BeanTask
createWebBean
-
Methods inherited from class com.microstrategy.web.app.tasks.WebComponentTask
addTransform, createUntypedWebComponent, destroy, generatesContent, getBeanInfo, getStyleName, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerTaskMetadata, requiresIServerSession, restoreBeanState, serializeResult, setBeanContext, setBeanInfo, setBeanName, setBeanProperties, setBeanSession, setSuccessfullyInitialized, setTaskID, transformBean
-
Methods inherited from class com.microstrategy.web.app.tasks.AbstractAppTask
getDescriptor
-
Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask
addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType
-
-
-
-
Field Detail
-
PARAM_NAME_SEARCH_XML
public static final java.lang.String PARAM_NAME_SEARCH_XML
- See Also:
- Constant Field Values
-
PARAM_NAME_QUICKSEARCH
public static final java.lang.String PARAM_NAME_QUICKSEARCH
- See Also:
- Constant Field Values
-
PARAM_NAME_SEARCHFIELDS
public static final java.lang.String PARAM_NAME_SEARCHFIELDS
- See Also:
- Constant Field Values
-
-
Method Detail
-
registerParameterMetadata
protected void registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Description copied from class:WebComponentTask
Registers a specific Task parameter metadata. This method is called byWebComponentTask.registerTaskMetadata(TaskMetadata)
. It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.- Overrides:
registerParameterMetadata
in classWebComponentTask
- Parameters:
parameterMetadata
- The TaskParameterMetadata object being saved.
-
collectData
protected void collectData(BeanTaskRequestContext btrContext) throws TaskException
Description copied from class:WebComponentTask
This method calls the 'collectData' method on the WebBean instance. This method is called byWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
.- Overrides:
collectData
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext object.- Throws:
TaskException
- If there is a failure while trying to collect data for the Web Bean.
-
handleEvent
protected void handleEvent(BeanTaskRequestContext bsrContext) throws TaskException
Description copied from class:WebComponentTask
This method instructs the WebBean to handle the event. It is called fromWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
.- Overrides:
handleEvent
in classWebComponentTask
- Parameters:
bsrContext
- The BeanTaskRequestContext that contains the WebBean instance.- Throws:
TaskException
- If something fails in the process of handling the event.TaskRequestMalformedException
- If there was an exception raised while handling the event.
-
prepareBean
protected void prepareBean(BeanTaskRequestContext bsrContext) throws TaskException
Description copied from class:WebComponentTask
This method prepares the WebBean for execution. It is called by theWebComponentTask.processRequest(TaskRequestContext, TaskOutput)
method. It performs the following actions:- Creates a new WebBean instance and adds it to the
context. (calls
WebComponentTask.createWebBean(BeanTaskRequestContext)
) - Sets any bean properties. (calls
WebComponentTask.setBeanProperties(BeanTaskRequestContext)
) - Restores any bean state. (calls
WebComponentTask.restoreBeanState(BeanTaskRequestContext)
)
- Overrides:
prepareBean
in classWebComponentTask
- Parameters:
bsrContext
- The BeanTaskRequestContext to use.- Throws:
TaskException
- If anything fails along the way.
- Creates a new WebBean instance and adds it to the
context. (calls
-
-