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

[Expand] Inherited Methods
From class com.microstrategy.web.transform.AbstractLayoutTransform LayoutContext getLayoutContext(Transformable data, boolean excludeStaticTags) Gets the LayoutContext instance to use for any layout processing. LayoutTag getLayoutDefinition() void setLayoutDefinition(LayoutTag layoutDefn) boolean transformUsingLayout(Transformable data, MarkupOutput markup, boolean excludeStaticTags) This method provides a way to transform the data using a supplied layout.
From class com.microstrategy.web.transform.AbstractTransform void addFormalParam(FormalParameterImpl formal) This method is used to add a FormalParameterImpl object to the transform. boolean canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform. static List<Integer> getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys. FormalParameters getFormalParams() Returns the collection of formal parameters associated with this transform. String getID() Returns the unique name of the component to be used as the ID for its shell MarkupOutput getPreview() Produces a preview output for this transform. boolean isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise. boolean isResolved() Returns whether each required formal parameter has a value associated with it. FormalParameterImpl removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection. void setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping. void setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping. boolean supports(Class type) Returns true if the transform supports objects of specified type. boolean supports(Transformable data) Returns true if the transform supports the specified data object.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.web.transform.LayoutTransform abstract LayoutTag getLayoutDefinition() Gets the in-memory layout definition associated with this transform instance. abstract void setLayoutDefinition(LayoutTag layoutDefn) Sets the in-memory layout defintion object to use with this transform instance.
From interface com.microstrategy.web.transform.Transform abstract boolean canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform. abstract String getDescription() Returns a textual description of the transform. abstract FormalParameters getFormalParams() Returns the collection of formal parameters associated with this transform. abstract String getID() Returns the unique name of the component to be used as the ID for its shell abstract MarkupOutput getPreview() This method is deprecated. This feature is not used abstract Class getSupportedBeanType() Returns a root class/interface supported by this transform. abstract boolean isPreviewAvailable() This method is deprecated. This feature is not used abstract boolean isResolved() Returns whether each required formal parameter has a value associated with it. abstract boolean supports(Class beanClass) Returns true if the transform supports objects of specified type. abstract boolean supports(Transformable data) Returns true if the transform supports the specified data object. abstract void transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.