Package com.microstrategy.web.app.tasks

Class AbstractSaveTask

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

All Implemented Interfaces:

Task

Direct Known Subclasses:

ReportSaveTask, RWSaveSegmentTask, RWSaveTask, RWSaveThemeTask

public class AbstractSaveTask
extends BeanTask

Abstract base class for tasks that save an object to metadata

Since:

MicroStrategy Web 8.1.2

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskParameterMetadata	descParam
protected TaskParameterMetadata	flagsParam
protected TaskParameterMetadata	folderIDParam
protected TaskParameterMetadata	nameParam
static java.lang.String	PARAM_NAME_FOLDER_ID
static java.lang.String	PARAM_NAME_REPORT_DESC
static java.lang.String	PARAM_NAME_REPORT_NAME
static java.lang.String	PARAM_NAME_SAVEAS_FLAGS
static java.lang.String	PARAM_NAME_SAVEAS_SKIPREBUILD
protected TaskParameterMetadata	skipRebuildParam

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

Method Summary

Modifier and Type	Method	Description
protected WebFolder	getWebFolder(RequestKeys rk, ObjectBean bean)
protected WebObjectsFactory	getWebObjectsFactory(WebBean wb)
void	processRequest(TaskRequestContext context, MarkupOutput out)	The default implementation of this version of processRequest is empty.
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, collectData, createUntypedWebComponent, destroy, generatesContent, getBeanInfo, getStyleName, handleEvent, init, isSuccessfullyInitialized, newRequestContext, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareBean, 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, 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

PARAM_NAME_FOLDER_ID

public static final java.lang.String PARAM_NAME_FOLDER_ID

See Also:

Constant Field Values

PARAM_NAME_REPORT_NAME

public static final java.lang.String PARAM_NAME_REPORT_NAME

See Also:

Constant Field Values

PARAM_NAME_REPORT_DESC

public static final java.lang.String PARAM_NAME_REPORT_DESC

See Also:

Constant Field Values

PARAM_NAME_SAVEAS_FLAGS

public static final java.lang.String PARAM_NAME_SAVEAS_FLAGS

See Also:

Constant Field Values

PARAM_NAME_SAVEAS_SKIPREBUILD

public static final java.lang.String PARAM_NAME_SAVEAS_SKIPREBUILD

See Also:

Constant Field Values

folderIDParam

protected TaskParameterMetadata folderIDParam

nameParam

protected TaskParameterMetadata nameParam

descParam

protected TaskParameterMetadata descParam

flagsParam

protected TaskParameterMetadata flagsParam

skipRebuildParam

protected TaskParameterMetadata skipRebuildParam

Constructor Detail

AbstractSaveTask

public AbstractSaveTask()

Method Detail

registerParameterMetadata

protected void registerParameterMetadata(TaskParameterMetadata parameterMetadata)

Description copied from class: WebComponentTask

Registers a specific Task parameter metadata. This method is called by WebComponentTask.registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.

Overrides:

registerParameterMetadata in class WebComponentTask

Parameters:

parameterMetadata - The TaskParameterMetadata object being saved.

Since:

MicroStrategy Web 9.0.0

getWebFolder

protected WebFolder getWebFolder(RequestKeys rk,
                                 ObjectBean bean)
                          throws TaskRequestMalformedException

Throws:

TaskRequestMalformedException

getWebObjectsFactory

protected WebObjectsFactory getWebObjectsFactory(WebBean wb)

processRequest

public void processRequest(TaskRequestContext context,
                           MarkupOutput out)
                    throws TaskException

Description copied from class: AbstractBaseTask

The default implementation of this version of processRequest is empty. Task implementators may override either version of processRequest.

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

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

out - The MarkupOutput that records the contents of the Task response.

Throws:

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

Since:

MicroStrategy Web 9.0.0

See Also:

Task.processRequest(TaskRequestContext, MarkupOutput)