public class

ResultSetStatusTransform

extends AbstractLayoutTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.ResultSetStatusTransform

Class Overview

This transform generates an XML that contains status information of the report such as message ID, report ID and whether is prompted or not.
The format of the output is as follows:

 <object-info>
   <object-id>46FA3908484146A2E7ECE08DE302D63C</object-id>
   <msg-id>8EA08C3446D6BE15910EA1B8A2126A0E</msg-id>
   <is-prompted>false</is-prompted>
   <prompt-url>http://...</prompt-url>  <-- optional if object is prompted
   <error>some error</error> <-- optional
   <last-update-time/> <-- reports only
   <total-rows/> <-- reports only
   <total-columns/> <-- reports only
   <bean-state/>
 </object-info>
 

Summary

Public Constructors
ResultSetStatusTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
Class getSupportedBeanType()
Returns a root class/interface supported by this transform.
boolean isError()
boolean isPrompted()
boolean isReport()
void renderBeanState(MarkupOutput out)
void renderErrorMessage(MarkupOutput out)
void renderGridTotalColumns(MarkupOutput out)
void renderGridTotalRows(MarkupOutput out)
void renderIsPrompted(MarkupOutput out)
void renderLastUpdateTime(MarkupOutput out)
void renderMessageID(MarkupOutput out)
void renderObjectID(MarkupOutput out)
void renderPromptURL(MarkupOutput out)
void renderStateID(MarkupOutput out)
void renderStatus(MarkupOutput out)
boolean supports(Transformable data)
Returns true if the transform supports the specified data object.
void transform(Transformable bean, MarkupOutput out)
Transforms the data object and appends result to the transOut.
Protected Methods
long convertToMillis(WebIServerSession iss, String time1)
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public ResultSetStatusTransform ()

Public Methods

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public Class getSupportedBeanType ()

Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.

Returns
  • a root class/interface supported by this transform.

public boolean isError ()

public boolean isPrompted ()

public boolean isReport ()

public void renderBeanState (MarkupOutput out)

public void renderErrorMessage (MarkupOutput out)

public void renderGridTotalColumns (MarkupOutput out)

public void renderGridTotalRows (MarkupOutput out)

public void renderIsPrompted (MarkupOutput out)

public void renderLastUpdateTime (MarkupOutput out)

public void renderMessageID (MarkupOutput out)

public void renderObjectID (MarkupOutput out)

public void renderPromptURL (MarkupOutput out)

public void renderStateID (MarkupOutput out)

public void renderStatus (MarkupOutput out)

public boolean supports (Transformable data)

Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.

Parameters
data a transformable object
Returns
  • true if the transform supports the data object, false otherwise.

public void transform (Transformable bean, MarkupOutput out)

Transforms the data object and appends result to the transOut.

Parameters
bean an object to transform. It must be of proper type supported by the concrete transform this method called on, or ClassCastExcetption will be thrown
out the MarkupOutput object where the transform result will be added.
Throws
ClassCastException

Protected Methods

protected long convertToMillis (WebIServerSession iss, String time1)