Package com.microstrategy.web.app.tasks
Class MojoRWManipulationTask
- 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.MojoRWManipulationTask
-
- All Implemented Interfaces:
Task
,EnumDSSXMLRWManipulationMethod
public class MojoRWManipulationTask extends BeanTask implements EnumDSSXMLRWManipulationMethod
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
EVENT_ARG_SOURCE_PARAMETER
protected static java.lang.String
EVENT_ARG_TRANSACTION_STRING
protected static java.lang.String
PARAM_DESC_CHANGES
protected static java.lang.String
PARAM_NAME_CHANGES
protected static java.lang.String
PARAM_NAME_MESSAGE_ID
protected static java.lang.String
PARAM_NAME_STATE_ID
-
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_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam
-
Fields inherited from interface com.microstrategy.webapi.EnumDSSXMLRWManipulationMethod
DssRWManipulationAddRWDDefinitionSubtotal, DssRWManipulationChangeConditionOnNode, DssRWManipulationConvertStitchingGridToNormal, DssRWManipulationConvertToStitchingGrid, DssRWManipulationCreateEmbeddedFilter, DssRWManipulationEditEmbeddedFilter, DssRWManipulationhSetControlFlagAndReexecuteTargetGridTemplates, DssRWManipulationRemoveRWDDefinitionSubtotal, DssRWManipulationReplaceControlSource, DssRWManipulationSetControlSynchronized, DssRWManipulationSetStitchGridPrimaryNode, DssRWManipulationSetTemplateLimit, DssRWManipulationToggleDatasetServeMode, DssXmlRWManipulationAddAssociatedRWNodes, DssXmlRWManipulationAddAttributeFormToField, DssXmlRWManipulationAddConsolidationObjectOnDataset, DssXmlRWManipulationAddControl, DssXmlRWManipulationAddControlMacro, DssXmlRWManipulationAddControlTarget, DssXmlRWManipulationAddControlTargetDataset, DssXmlRwManipulationAddControlTargetEx, DssXmlRWManipulationAddControlTargetPlaceHolders, DssXmlRWManipulationAddCopyTemplateNodeFromDataset, DssXmlRWManipulationAddDataSet, DssXmlRWManipulationAddDerivedAttributeToDataset, DssXmlRWManipulationAddDerivedElementToManagedConsolidationObject, DssXmlRWManipulationAddDerivedMetricToDataset, DssXmlRWManipulationAddDocumentView, DssXmlRWManipulationAddField, DssXmlRWManipulationAddGroupBySection, DssXmlRWManipulationAddGroupByUnit, DssXmlRWManipulationAddLayout, DssXmlRWManipulationAddLinkTemplateNodeToDataset, DssXmlRWManipulationAddNode, DssXmlRWManipulationAddObjectField, DssXmlRWManipulationAddOfflineTransaction, DssXmlRWManipulationAddShortcutMetric, DssXmlRWManipulationAddSort, DssXmlRWManipulationAddTransactionReport, DssXmlRWManipulationApplyAttributeRemapping, DssXmlRWManipulationApplyReconciliation, DssXmlRWManipulationApplySegment, DssXmlRWManipulationChangeControlCondition, DssXmlRWManipulationChangeControlText, DssXmlRWManipulationChangeTemplateNodeOrigin, DssXmlRWManipulationClearAssociatedRWNodes, DssXmlRWManipulationClearControls, DssXmlRWManipulationClearControlTargetDatasets, DssXmlRWManipulationClearControlTargets, DssXmlRWManipulationClearCurrentControlElements, DssXmlRWManipulationClearDataSets, DssXmlRWManipulationClearFields, DssXmlRWManipulationClearGroupByUnits, DssXmlRWManipulationClearNodes, DssXmlRWManipulationClearSorts, DssXmlRWManipulationClearTransactionReport, DssXmlRWManipulationConvertDatasetToManaged, DssXMLRWManipulationCopyControl, DssXmlRWManipulationCopyField, DssXmlRWManipulationCopyLayout, DssXmlRWManipulationCopyPanel, DssXmlRWManipulationCopyPanelStack, DssXmlRWManipulationCopyTemplateNode, DssXmlRWManipulationCreateDataSet, DssXmlRWManipulationCreateThreshold, DssXmlRWManipulationDatasetManipulation, DssXmlRWManipulationDrill, DssXmlRWManipulationEditDataSet, DssXmlRWManipulationEditDocumentLinks, DssXMLRWManipulationEditDocumentUnitProperty, DssXmlRWManipulationEditDocumentView, DssXmlRWManipulationEditField, DssXmlRWManipulationEditNode, DssXmlRWManipulationEditObjectField, DssXmlRWManipulationEditSectionNode, DssXmlRWManipulationEnsureFilterModeMacro, DssXmlRWManipulationFormatControl, DssXmlRWManipulationFormatDerivedElementOnManagedConsolidationObject, DssXmlRWManipulationFormatDerivedMetric, DssXmlRWManipulationFormatField, DssXmlRWManipulationFormatNode, DssXmlRWManipulationHideDocumentThresholds, DssXmlRWManipulationImportDocument, DssXmlRWManipulationInsertControlGroupBySection, DssXmlRWManipulationMacroCopyNode, DssXMlRWManipulationMakeTabular, DssXmlRWManipulationMoveControlGroupBySection, DssXmlRWManipulationMoveField, DssXmlRWManipulationMoveGroupBySection, DssXmlRWManipulationMoveNode, DssXmlRWManipulationMoveNodeMacro, DssXmlRWManipulationMoveTemplateNode, DssXmlRWManipulationPerformActionOnActionSelector, DssXmlRWManipulationPopulateTemplateNodeFromDataset, DssXmlRWManipulationRefreshReport, DssXmlRWManipulationRemoveControl, DssXmlRWManipulationRemoveControlGroupBySection, DssXmlRWManipulationRemoveControlMacro, DssXmlRWManipulationRemoveControlTarget, DssXmlRWManipulationRemoveControlTargetDataset, DssXmlRWManipulationRemoveControlTargetEx, DssXmlRWManipulationRemoveControlTargetPlaceHolders, DssXmlRWManipulationRemoveDataSet, DssXmlRWManipulationRemoveDerivedAttributeFromDataset, DssXmlRWManipulationRemoveDerivedElementFromManagedConsolidationObject, DssXmlRWManipulationRemoveDerivedMetricFromDataset, DssXmlRWManipulationRemoveDocumentView, DssXmlRWManipulationRemoveField, DssXmlRWManipulationRemoveGroupByAndFieldGroupSortInLayout, DssXmlRWManipulationRemoveGroupBySection, DssXmlRWManipulationRemoveManagedConsolidationFromDataset, DssXmlRWManipulationRemoveNode, DssXmlRWManipulationRemoveNodeMacro, DssXmlRWManipulationRemoveOfflineTransaction, DssXmlRWManipulationRemovePreferredThemeOnNode, DssXmlRWManipulationRemoveThreshold, DssXmlRWManipulationRemoveTransactionInfoOnField, DssXmlRWManipulationRemoveTransactionReport, DssXmlRWManipulationRemoveWidgetString, DssXmlRWManipulationRenameDataset, DssXmlRWManipulationReorderThresholds, DssXmlRWManipulationReplaceDataset, DssXmlRWManipulationReportManipulation, DssXmlRWManipulationReserved, DssXmlRWManipulationResetSelections, DssXmlRWManipulationSetAbbreviation, DssXmlRWManipulationSetAttributeReplacement, DssXmlRWManipulationSetAutomaticTransactionRecordNumber, DssXmlRWManipulationSetCandidateAttributes, DssXmlRWManipulationSetControlAllAlias, DssXmlRWManipulationSetControlAttributeFormDisplayOption, DssXmlRWManipulationSetControlAttributeForms, DssXmlRWManipulationSetControlAvailableActionTypes, DssXmlRWManipulationSetControlDataSource, DssXmlRWManipulationSetControlDelimiter, DssXmlRWManipulationSetControlDisplayText, DssXmlRWManipulationSetControlFilterType, DssXmlRWManipulationSetControlMatchForm, DssXMLRWManipulationSetControlShowAll, DssXMLRWManipulationSetControlSource, DssXmlRWManipulationSetControlSubsequentAction, DssXmlRWManipulationSetControlUnsetStatus, DssXmlRWManipulationSetControlWriteBackForm, DssXmlRWManipulationSetCurrentControlElements, DssXMLRWManipulationSetCurrentControlElementsFromGraph, DssXMLRWManipulationSetCurrentControlElementStatus, DssXmlRWManipulationSetCurrentDocumentView, DssXmlRWManipulationSetCurrentGroupByElement, DssXmlRWManipulationSetCurrentGroupByElementByUnitID, DssXmlRWManipulationSetCurrentLayout, DssXmlRWManipulationSetCurrentNode, DssXmlRWManipulationSetDatasetTargetElementSource, DssXmlRWManipulationSetDefaultDataSet, DssXmlRWManipulationSetDefaultFormat, DssXmlRWManipulationSetDerivedElementHierarchyOptionOnManagedConsolidationObject, DssXmlRWManipulationSetDerivedElementPropertiesOnManagedConsolidationObject, DssXmlRWManipulationSetDocumentProperties, DssXmlRWManipulationSetGraphProperties, DssXmlRWManipulationSetGridDisplayMode, DssXmlRWManipulationSetNextCurrentGroupByElement, DssXmlRWManipulationSetPageByStyle, DssXmlRWManipulationSetPreferredPalette, DssXmlRWManipulationSetPreferredTheme, DssXmlRWManipulationSetPreferredThemeOnNode, DssXmlRWManipulationSetRWDObjectProperties, DssXmlRWManipulationSetSubmitOrderForTransaction, DssXmlRWManipulationSetSubsequentActionObject, DssXmlRWManipulationSetSubsequentDisplayMessage, DssXmlRWManipulationSetTransactionChangeType, DssXmlRWManipulationSetTransactionInfoOnField, DssXMLRWManipulationSetTransactionReport, DssXmlRWManipulationSetUnitPropertiesInTargetFolder, DssXmlRWManipulationSetViewFilter, DssXmlRWManipulationSetViewTemplate, DssXmlRWManipulationSetWidgetString, DssXmlRWManipulationShowDocumentThresholds, DssXmlRWManipulationSwitchControlGroupBySectionToUnitCondition, DssXmlRWManipulationSwitchUnitConditionToControlGroupBySection, DssXmlRWManipulationToggleCurrentSelectionOnControl, DssXmlRWManipulationUpdateConsolidationObject, DssXmlRWManipulationUpdateDerivedAttributeOnDataset, DssXmlRWManipulationUpdateDerivedElementOnManagedConsolidationObject, DssXmlRWManipulationUpdateDerivedMetricOnDataset, DssXmlRWManipulationUpdateElementColorMappings, DssXmlRWManipulationUpdateOfflineTransaction, DssXmlRWManipulationUpdateShortcutMetric, DssXmlRWManipulationUpdateThreshold, DssXmlRWManipulationUpdateTransactionData, DssXmlRWManipulationValidateExpression
-
-
Constructor Summary
Constructors Constructor Description MojoRWManipulationTask()
-
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 java.lang.String
getStyleName(BeanTaskRequestContext btrContext)
protected void
handleEvent(BeanTaskRequestContext btrContext)
This method instructs the WebBean to handle the event.protected void
overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance)
Overrides any actual parameters specified in the Bean Task XML.protected void
prepareBean(BeanTaskRequestContext btrContext)
This method prepares the WebBean for execution.protected void
prepareEventRequestKeys(RequestKeys requestKeys, EventInfo[] events)
void
processRequest(TaskRequestContext context, TaskOutput taskOutput)
Process the incoming request.protected void
registerParameterMetadata(TaskParameterMetadata parameterMetadata)
Registers a specific Task parameter metadata.void
saveViewFilterLimitHandler(RWDelta delta, JSONObject action, RWBean rwBean)
protected void
transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method wraps a call toTransformable.transform()
.-
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, init, isSuccessfullyInitialized, newRequestContext, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, registerTaskMetadata, requiresIServerSession, restoreBeanState, serializeResult, setBeanContext, setBeanInfo, setBeanName, setBeanProperties, setBeanSession, setSuccessfullyInitialized, setTaskID
-
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_MESSAGE_ID
protected static final java.lang.String PARAM_NAME_MESSAGE_ID
- See Also:
- Constant Field Values
-
PARAM_NAME_STATE_ID
protected static final java.lang.String PARAM_NAME_STATE_ID
- See Also:
- Constant Field Values
-
PARAM_NAME_CHANGES
protected static final java.lang.String PARAM_NAME_CHANGES
- See Also:
- Constant Field Values
-
PARAM_DESC_CHANGES
protected static final java.lang.String PARAM_DESC_CHANGES
- See Also:
- Constant Field Values
-
EVENT_ARG_TRANSACTION_STRING
protected static final java.lang.String EVENT_ARG_TRANSACTION_STRING
- See Also:
- Constant Field Values
-
EVENT_ARG_SOURCE_PARAMETER
protected static final java.lang.String EVENT_ARG_SOURCE_PARAMETER
- 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.
-
processRequest
public void processRequest(TaskRequestContext context, TaskOutput taskOutput) throws TaskException
Description copied from class:WebComponentTask
Process the incoming request. This method proceeds through the following sequence:- Check for all required parameters. (calls
AbstractBaseTask.checkForRequiredParameters(RequestKeys)
) - Prepare the
RequestKeys
for use. (callsWebComponentTask.prepareRequestKeys(BeanTaskRequestContext)
) - Prepare the
WebBean
for use. (callsWebComponentTask.prepareBean(BeanTaskRequestContext)
) - Handle the event. (calls
WebComponentTask.handleEvent(BeanTaskRequestContext)
) - Collect data for the request. (calls
WebComponentTask.collectData(BeanTaskRequestContext)
) - Serialize the results into the supplied
TaskOutput
. (callsWebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput)
)
- Specified by:
processRequest
in interfaceTask
- Overrides:
processRequest
in classWebComponentTask
- Parameters:
context
- TheTaskRequestContext
object that contains information specific to this request.taskOutput
- TheTaskOutput
object to serialize the results into.- Throws:
TaskException
- If anything fails in the process of servicing the request.TaskConfigurationException
- If the task is not properly configured.- See Also:
Task.processRequest(TaskRequestContext, TaskOutput)
- Check for all required parameters. (calls
-
prepareBean
protected void prepareBean(BeanTaskRequestContext btrContext) 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:
btrContext
- The BeanTaskRequestContext to use.- Throws:
TaskException
- If anything fails along the way.
- Creates a new WebBean instance and adds it to the
context. (calls
-
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.
-
transformBean
protected void transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput) throws TaskConfigurationException
Description copied from class:WebComponentTask
This method wraps a call toTransformable.transform()
. It is called by theWebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput)
method and simply calls the 'transform' method.- Overrides:
transformBean
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext object.taskOutput
- The TaskOutput instance to generate into.- Throws:
TaskConfigurationException
- If the Transform does not exist.
-
prepareEventRequestKeys
protected void prepareEventRequestKeys(RequestKeys requestKeys, EventInfo[] events)
- Overrides:
prepareEventRequestKeys
in classWebComponentTask
-
getStyleName
protected java.lang.String getStyleName(BeanTaskRequestContext btrContext) throws TaskRequestMalformedException
- Overrides:
getStyleName
in classWebComponentTask
- Throws:
TaskRequestMalformedException
-
overrideActualParameters
protected void overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance) throws TaskRequestMalformedException
Description copied from class:WebComponentTask
Overrides any actual parameters specified in the Bean Task XML. This method is called by theWebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput)
method.- Overrides:
overrideActualParameters
in classWebComponentTask
- Parameters:
btrContext
- The BeanTaskRequestContext to use.instance
- The TransformInstance to operate on.- Throws:
TaskRequestMalformedException
-
handleEvent
protected void handleEvent(BeanTaskRequestContext btrContext) 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:
btrContext
- 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.
-
saveViewFilterLimitHandler
public void saveViewFilterLimitHandler(RWDelta delta, JSONObject action, RWBean rwBean) throws java.lang.Exception
- Throws:
java.lang.Exception
-
-