Package com.microstrategy.web.app.transforms

Class ResultSetStatusTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.ResultSetStatusTransform

All Implemented Interfaces:

LayoutTransform, Transform

public class ResultSetStatusTransform
extends AbstractLayoutTransform
implements LayoutTransform

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>
 

Since:

MicroStrategy Web 8.1.0

Constructor Summary

Constructors

Constructor	Description
ResultSetStatusTransform()

Method Summary

Modifier and Type	Method	Description
protected long	convertToMillis(WebIServerSession iss, java.lang.String time1)
java.lang.String	getDescription()	Returns a textual description of the transform.
java.lang.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.

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutContext, getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports

Constructor Detail

ResultSetStatusTransform

public ResultSetStatusTransform()

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Specified by:

getDescription in interface Transform

Returns:

The textual description of the transform.

transform

public void transform(Transformable bean,
                      MarkupOutput out)
               throws java.lang.ClassCastException

Description copied from interface: Transform

Transforms the data object and appends result to the transOut.

Specified by:

transform in interface Transform

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:

java.lang.ClassCastException - if data is of the wrong type.

renderErrorMessage

public void renderErrorMessage(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

isError

public boolean isError()

Since:

MicroStrategy Web 9.0.0

isReport

public boolean isReport()

Since:

MicroStrategy Web 9.0.0

isPrompted

public boolean isPrompted()

Since:

MicroStrategy Web 9.0.0

renderBeanState

public void renderBeanState(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderGridTotalColumns

public void renderGridTotalColumns(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderGridTotalRows

public void renderGridTotalRows(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderLastUpdateTime

public void renderLastUpdateTime(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderIsPrompted

public void renderIsPrompted(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderObjectID

public void renderObjectID(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderMessageID

public void renderMessageID(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

renderStatus

public void renderStatus(MarkupOutput out)

renderStateID

public void renderStateID(MarkupOutput out)

renderPromptURL

public void renderPromptURL(MarkupOutput out)

Since:

MicroStrategy Web 9.0.0

supports

public boolean supports(Transformable data)

Description copied from interface: Transform

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.

Specified by:

supports in interface Transform

Overrides:

supports in class AbstractTransform

Parameters:

data - a transformable object

Returns:

true if the transform supports the data object, false otherwise.

See Also:

Transform.canTransform(com.microstrategy.web.beans.Transformable)

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Description copied from interface: Transform

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

Specified by:

getSupportedBeanType in interface Transform

Returns:

a root class/interface supported by this transform.

convertToMillis

protected long convertToMillis(WebIServerSession iss,
                               java.lang.String time1)

Since:

MicroStrategy Web 9.0.0