Package com.microstrategy.web.app.tasks

Class IPhoneReportResultsTask

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

All Implemented Interfaces:

Task

public class IPhoneReportResultsTask
extends BeanTask

Since:

MicroStrategy Web 8.1.1

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	PARAM_NAME_DESIRED_PAGE_BY_KEYS
static java.lang.String	PARAM_NAME_MAX_ROW_ELEMENTS
static java.lang.String	PARAM_NAME_MESSAGEID
protected static java.lang.String	PARAM_NAME_PAGE_BY_KEYS
static java.lang.String	PARAM_NAME_STYLE_NAME

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

Method Summary

Modifier and Type	Method	Description
protected void	collectData(BeanTaskRequestContext bsrContext)	This method calls the 'collectData' method on the WebBean instance.
protected void	handlePageBy(BeanTaskRequestContext bsrContext, ReportBean rb)
TaskRequestContext	newRequestContext()	Returns a BeanTaskRequestContext object to use for the duration of this request.
protected void	prepareBean(BeanTaskRequestContext bsrContext)	This method prepares the WebBean for execution.
protected void	transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)	This method wraps a call to Transformable.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, getStyleName, handleEvent, init, isSuccessfullyInitialized, overrideActualParameters, prepareArgumentRequestKeys, prepareArgumentRequestKeys, prepareEventOrderRequestKeys, prepareEventOrderRequestKeys, prepareEventRequestKeys, prepareEventRequestKeys, prepareParameterRequestKeys, prepareRequestKeys, processRequest, registerParameterMetadata, 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

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_NAME_MESSAGEID

public static final java.lang.String PARAM_NAME_MESSAGEID

See Also:

Constant Field Values

PARAM_NAME_STYLE_NAME

public static final java.lang.String PARAM_NAME_STYLE_NAME

See Also:

Constant Field Values

PARAM_NAME_MAX_ROW_ELEMENTS

public static final java.lang.String PARAM_NAME_MAX_ROW_ELEMENTS

See Also:

Constant Field Values

PARAM_NAME_PAGE_BY_KEYS

protected static final java.lang.String PARAM_NAME_PAGE_BY_KEYS

See Also:

Constant Field Values

PARAM_NAME_DESIRED_PAGE_BY_KEYS

protected static final java.lang.String PARAM_NAME_DESIRED_PAGE_BY_KEYS

See Also:

Constant Field Values

Constructor Detail

IPhoneReportResultsTask

public IPhoneReportResultsTask()

Method Detail

collectData

protected void collectData(BeanTaskRequestContext bsrContext)
                    throws TaskException

Description copied from class: WebComponentTask

This method calls the 'collectData' method on the WebBean instance. This method is called by WebComponentTask.processRequest(TaskRequestContext, TaskOutput).

Overrides:

collectData in class WebComponentTask

Parameters:

bsrContext - The BeanTaskRequestContext object.

Throws:

TaskException - If there is a failure while trying to collect data for the Web Bean.

prepareBean

protected void prepareBean(BeanTaskRequestContext bsrContext)
                    throws TaskException

Description copied from class: WebComponentTask

This method prepares the WebBean for execution. It is called by the WebComponentTask.processRequest(TaskRequestContext, TaskOutput) method. It performs the following actions:

1. Creates a new WebBean instance and adds it to the context. (calls WebComponentTask.createWebBean(BeanTaskRequestContext))
2. Sets any bean properties. (calls WebComponentTask.setBeanProperties(BeanTaskRequestContext))
3. Restores any bean state. (calls WebComponentTask.restoreBeanState(BeanTaskRequestContext))

Overrides:

prepareBean in class WebComponentTask

Parameters:

bsrContext - The BeanTaskRequestContext to use.

Throws:

TaskException - If anything fails along the way.

transformBean

protected void transformBean(BeanTaskRequestContext btrContext,
                             TaskOutput taskOutput)
                      throws TaskConfigurationException

Description copied from class: WebComponentTask

This method wraps a call to Transformable.transform(). It is called by the WebComponentTask.serializeResult(BeanTaskRequestContext, TaskOutput) method and simply calls the 'transform' method.

Overrides:

transformBean in class WebComponentTask

Parameters:

btrContext - The BeanTaskRequestContext object.

taskOutput - The TaskOutput instance to generate into.

Throws:

TaskConfigurationException - If the Transform does not exist.

Since:

MicroStrategy Web 9.0.0

newRequestContext

public TaskRequestContext newRequestContext()

Description copied from class: WebComponentTask

Returns a BeanTaskRequestContext object to use for the duration of this request.

Specified by:

newRequestContext in interface Task

Overrides:

newRequestContext in class WebComponentTask

Returns:

The BeanTaskRequestContext object to use for the duration of this request.

handlePageBy

protected void handlePageBy(BeanTaskRequestContext bsrContext,
                            ReportBean rb)
                     throws WebBeanException,
                            WebObjectsException,
                            TaskException,
                            TaskInternalException

Throws:

WebBeanException

WebObjectsException

TaskException

TaskInternalException