Package com.microstrategy.web.app.tasks.architect

Class SearchTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.tasks.AbstractArchitectTask

com.microstrategy.web.app.tasks.architect.SearchTask

All Implemented Interfaces:

Task

public class SearchTask
extends AbstractArchitectTask

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	accessTaskParam
protected TaskParameterMetadata	dbRoleIdsParam
protected TaskParameterMetadata	domainTaskParam
protected TaskParameterMetadata	flagsTaskParam
protected TaskParameterMetadata	isDataImportParam
protected TaskParameterMetadata	nameTaskParam
protected TaskParameterMetadata	objectTypesTaskParam
protected TaskParameterMetadata	schemaIDTaskParam
protected TaskParameterMetadata	searchObjFlagsTaskParam
protected TaskParameterMetadata	specialParseTaskParam
protected TaskParameterMetadata	typeExcludeFilterParam
protected TaskParameterMetadata	typeFilterParam
protected TaskParameterMetadata	usedbyTaskParam
protected TaskParameterMetadata	usesTaskParam
protected TaskParameterMetadata	versionExcludeFilterParam
protected TaskParameterMetadata	versionFilterParam
protected TaskParameterMetadata	xmlFlagsTaskParam

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
SearchTask()

Method Summary

Modifier and Type	Method	Description
protected Block	adjustDBRoleBlock(WebIServerSession iSession, Block iBlock)
Block	process(WebObjectsFactory factory, java.lang.String typeFilters, java.lang.String versionFilters, java.lang.String typeExcludeFilters, java.lang.String versionExcludeFilters, java.lang.Boolean isDI, java.lang.String output, java.lang.String parseopt)
Block	process(WebObjectsFactory factory, java.lang.String typeFilters, java.lang.String versionFilters, java.lang.String typeExcludeFilters, java.lang.String versionExcludeFilters, java.lang.Boolean isDI, java.lang.String output, java.lang.String parseopt, java.lang.String dbRoleIds)
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.
java.lang.String	processRunSearch(java.lang.String sessionID, java.lang.String siid, java.lang.String types, java.lang.String acg, java.lang.String domain, int flags, java.lang.String name, java.lang.String usedby, java.lang.String uses, int xmlFlags, int searchFlags)
protected java.lang.String	RunSearch(WebIServerSession session, RequestKeys requestKeys)
protected void	SplitAndAddTypes(XMLBuilder builder, java.lang.String types)
protected void	SplitAndAddUsedBy(XMLBuilder builder, java.lang.String usedby)
protected void	SplitAndAddUses(XMLBuilder builder, java.lang.String uses)

Methods inherited from class com.microstrategy.web.tasks.AbstractArchitectTask

checkUserPrivilege, getRequestTimeout

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, destroy, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, init, newRequestContext, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objectTypesTaskParam

protected TaskParameterMetadata objectTypesTaskParam

schemaIDTaskParam

protected TaskParameterMetadata schemaIDTaskParam

accessTaskParam

protected TaskParameterMetadata accessTaskParam

domainTaskParam

protected TaskParameterMetadata domainTaskParam

flagsTaskParam

protected TaskParameterMetadata flagsTaskParam

nameTaskParam

protected TaskParameterMetadata nameTaskParam

usedbyTaskParam

protected TaskParameterMetadata usedbyTaskParam

usesTaskParam

protected TaskParameterMetadata usesTaskParam

xmlFlagsTaskParam

protected TaskParameterMetadata xmlFlagsTaskParam

searchObjFlagsTaskParam

protected TaskParameterMetadata searchObjFlagsTaskParam

specialParseTaskParam

protected TaskParameterMetadata specialParseTaskParam

typeFilterParam

protected TaskParameterMetadata typeFilterParam

versionFilterParam

protected TaskParameterMetadata versionFilterParam

typeExcludeFilterParam

protected TaskParameterMetadata typeExcludeFilterParam

versionExcludeFilterParam

protected TaskParameterMetadata versionExcludeFilterParam

isDataImportParam

protected TaskParameterMetadata isDataImportParam

dbRoleIdsParam

protected TaskParameterMetadata dbRoleIdsParam

Constructor Detail

SearchTask

public SearchTask()

Method Detail

processRequest

public void processRequest(TaskRequestContext context,
                           TaskOutput taskOutput)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this method of processRequest gets the Primary Content from the TaskOutput and invokes the AbstractBaseTask.processRequest(TaskRequestContext, MarkupOutput) version.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that maintains the state of the request.

taskOutput - The TaskOutput that contains the output generated by the Task.

Throws:

TaskException - If the Task was unable to satisfy the request.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)

process

public Block process(WebObjectsFactory factory,
                     java.lang.String typeFilters,
                     java.lang.String versionFilters,
                     java.lang.String typeExcludeFilters,
                     java.lang.String versionExcludeFilters,
                     java.lang.Boolean isDI,
                     java.lang.String output,
                     java.lang.String parseopt)
              throws TaskException

Throws:

TaskException

process

public Block process(WebObjectsFactory factory,
                     java.lang.String typeFilters,
                     java.lang.String versionFilters,
                     java.lang.String typeExcludeFilters,
                     java.lang.String versionExcludeFilters,
                     java.lang.Boolean isDI,
                     java.lang.String output,
                     java.lang.String parseopt,
                     java.lang.String dbRoleIds)
              throws TaskException

Throws:

TaskException

adjustDBRoleBlock

protected Block adjustDBRoleBlock(WebIServerSession iSession,
                                  Block iBlock)
                           throws TaskException

Throws:

TaskException

RunSearch

protected java.lang.String RunSearch(WebIServerSession session,
                                     RequestKeys requestKeys)
                              throws TaskException

Throws:

TaskException

processRunSearch

public java.lang.String processRunSearch(java.lang.String sessionID,
                                         java.lang.String siid,
                                         java.lang.String types,
                                         java.lang.String acg,
                                         java.lang.String domain,
                                         int flags,
                                         java.lang.String name,
                                         java.lang.String usedby,
                                         java.lang.String uses,
                                         int xmlFlags,
                                         int searchFlags)
                                  throws TaskException

Throws:

TaskException

SplitAndAddTypes

protected void SplitAndAddTypes(XMLBuilder builder,
                                java.lang.String types)

SplitAndAddUsedBy

protected void SplitAndAddUsedBy(XMLBuilder builder,
                                 java.lang.String usedby)
                          throws TaskRequestMalformedException

Throws:

TaskRequestMalformedException

SplitAndAddUses

protected void SplitAndAddUses(XMLBuilder builder,
                               java.lang.String uses)
                        throws TaskRequestMalformedException

Throws:

TaskRequestMalformedException