public class

MobileGridResultsTask

extends BeanTask
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.MobileGridResultsTask

Summary

Constants
String PARAM_NAME_MESSAGEID
String PARAM_NAME_REPORT_STATE_XML
String PARAM_NAME_STATE_ID
String PARAM_NAME_XML_VERSION
[Expand]
Inherited Constants
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
[Expand]
Inherited Fields
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.tasks.AbstractBaseTask
Public Constructors
MobileGridResultsTask()
Public Methods
TaskRequestContext newRequestContext()
Returns a BeanTaskRequestContext object to use for the duration of this request.
Protected Methods
void collectData(BeanTaskRequestContext bsrContext)
This method calls the 'collectData' method on the WebBean instance.
WebResultSetInstance duplicateMessageAndWaitForResult(String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk)
WebResultSetInstance getInitialInstance(String messageID, int stateID, WebObjectsFactory factory)
WebResultSetInstance getNewInstanceForDuplicatedMessage(String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk)
boolean hasMobileState(RequestKeys rk)
void makeTabular(WebTemplate t)
boolean makeTabular(WebTemplate t, boolean removeSubtotals)
void moveUnit(WebTemplate template, MobileUnit unit)
void overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance)
Overrides any actual parameters specified in the Bean Task XML.
void prepareBean(BeanTaskRequestContext bsrContext)
This method prepares the WebBean for execution.
void restoreMobileState(WebTemplate template, MobileTemplate mbTemplate, boolean includePageByManipulation)
void setCurrentElement(WebTemplate template, MobileUnit unit)
void transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)
This method wraps a call to transform().
[Expand]
Inherited Methods
From class com.microstrategy.web.app.tasks.BeanTask
From class com.microstrategy.web.app.tasks.WebComponentTask
From class com.microstrategy.web.app.tasks.AbstractAppTask
From class com.microstrategy.web.tasks.AbstractBaseTask
From class java.lang.Object
From interface com.microstrategy.web.tasks.Task

Constants

public static final String PARAM_NAME_MESSAGEID

Constant Value: "messageID"

public static final String PARAM_NAME_REPORT_STATE_XML

Constant Value: "reportState"

public static final String PARAM_NAME_STATE_ID

Constant Value: "stateID"

public static final String PARAM_NAME_XML_VERSION

Constant Value: "xmlVersion"

Public Constructors

public MobileGridResultsTask ()

Public Methods

public TaskRequestContext newRequestContext ()

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

Returns

Protected Methods

protected void collectData (BeanTaskRequestContext bsrContext)

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

Parameters
bsrContext The BeanTaskRequestContext object.
Throws
TaskException

protected WebResultSetInstance duplicateMessageAndWaitForResult (String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk)

protected WebResultSetInstance getInitialInstance (String messageID, int stateID, WebObjectsFactory factory)

protected WebResultSetInstance getNewInstanceForDuplicatedMessage (String messageID, int stateID, WebObjectsFactory factory, RequestKeys rk)

protected boolean hasMobileState (RequestKeys rk)

protected void makeTabular (WebTemplate t)

protected boolean makeTabular (WebTemplate t, boolean removeSubtotals)

protected void moveUnit (WebTemplate template, MobileUnit unit)

protected void overrideActualParameters (BeanTaskRequestContext btrContext, TransformInstance instance)

Overrides any actual parameters specified in the Bean Task XML. This method is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method.

Parameters
btrContext The BeanTaskRequestContext to use.
instance The TransformInstance to operate on.

protected void prepareBean (BeanTaskRequestContext bsrContext)

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

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

Parameters
bsrContext The BeanTaskRequestContext to use.
Throws
TaskException

protected void restoreMobileState (WebTemplate template, MobileTemplate mbTemplate, boolean includePageByManipulation)

protected void setCurrentElement (WebTemplate template, MobileUnit unit)

protected void transformBean (BeanTaskRequestContext btrContext, TaskOutput taskOutput)

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

Parameters
btrContext The BeanTaskRequestContext object.
taskOutput The TaskOutput instance to generate into.