public abstract class

AbstractRWTransform

extends AbstractWebBeanTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractRWTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractRWTransform is an abstract class which acts as a super class for all report writing transforms. All functional report writing transform classes, such as RWLayoutTransform, RWSavePropertiesTransform, etc should extend from it.

Summary

Nested Classes
class AbstractRWTransform.ButtonAlignmentsHelper Helper for button alignment configuration. 
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter imgError The name of the image used when the bean is in error status.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractRWTransform()
Default no argument constructor.
Public Methods
void generateErrorForIframe(MarkupOutput out, String title, String message, String errorInfo, String contactInfo, Tag extra)
WebEvent getContinueEvent()
Returns an event to continue browsing if an error happened.
String getDocumentStatus(int status)
Get the document's status as a string representation.
static int getDocumentStatusDescriptorKey(int status)
Get the descriptor key for the document's status.
String getErrorMessage(WebBeanError error)
Returns the error message for the transform, based on the error.
String getErrorTitle(WebBeanError error)
Returns the error title for the transform, based on the error.
String getJobExpiredMessage()
String getReexecuteButtonDescription()
Class getSupportedBeanType()
Returns the supported bean type for the transform.
WebEvent getWebReexecuteEvent()
Returns the reexecute event Always get the event from the servlet.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderImage(MarkupOutput out, String image)
Renders a image for this transform.
void renderProcessingButtons(MarkupOutput out)
Renders the buttons while processing.
void renderProcessingInfo(MarkupOutput out)
Renders the information about the bean.
void setWebReexecuteEventArguments(WebEvent __result)
Sets the reexecute web event's arguments
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
void transformForRequestNotInited(MarkupOutput out)
Transform when the status is Not initialized.
Protected Methods
WebEvent getCancelEvent()
WebEvent getHistoryListEvent()
WebInboxSource getInboxSource()
return the WebInboxSource of this session.
RWBean getRWBean()
Returns the report writing bean being transformed.
RWFrameBean getRWFrame()
WebEvent getRefreshEvent()
WebEvent getViewDetailsEvent()
boolean isDesignMode()
void renderHistoryListButton(MarkupOutput out)
Renders the History List button for the wait page.
void renderProcessingInfoDetails(MarkupOutput out)
void renderViewDetailsButton(MarkupOutput out)
Renders the View Details button for the wait page.
void updateVisTransform(TransformInstance transformInstance, RWObject object)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameter imgError

The name of the image used when the bean is in error status. Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Public Constructors

public AbstractRWTransform ()

Default no argument constructor.

Public Methods

public void generateErrorForIframe (MarkupOutput out, String title, String message, String errorInfo, String contactInfo, Tag extra)

public WebEvent getContinueEvent ()

Returns an event to continue browsing if an error happened.

public String getDocumentStatus (int status)

Get the document's status as a string representation.

Parameters
status the status as an integer
Returns
  • the status string

public static int getDocumentStatusDescriptorKey (int status)

Get the descriptor key for the document's status.

Parameters
status the status as an integer
Returns
  • the descriptor key as in integer

public String getErrorMessage (WebBeanError error)

Returns the error message for the transform, based on the error.

Parameters
error WebBeanError instance with the information that made the document to break
Returns
  • The error message.

public String getErrorTitle (WebBeanError error)

Returns the error title for the transform, based on the error.

Parameters
error WebBeanError instance with the information that made the document to break
Returns
  • The title for the error message.

public String getJobExpiredMessage ()

Returns
  • the job expired message.

public String getReexecuteButtonDescription ()

Returns
  • the description of the reexecute button

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns
  • The RWBean bean for this transform.

public WebEvent getWebReexecuteEvent ()

Returns the reexecute event Always get the event from the servlet.

Returns
  • the web reexecute event

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.
It also invokes the initializeTransform method of the parent.

Parameters
data The bean to transform.

public void renderImage (MarkupOutput out, String image)

Renders a image for this transform.
Extends by including images of this transform.

Parameters
out Output by this transform.
image The image name

public void renderProcessingButtons (MarkupOutput out)

Renders the buttons while processing. By default renders a "Check Status" button, associated with a EnumPageEvents.WebEventRefresh event, 'Add to History List', and a "Cancel this Request" buttons associated with a EnumServletEvents.WebEventCancel event.

Parameters
out output by this transform

public void renderProcessingInfo (MarkupOutput out)

Renders the information about the bean. Overwrites this method by showing information specific for the rw document.

Parameters
out output by this transform

public void setWebReexecuteEventArguments (WebEvent __result)

Sets the reexecute web event's arguments

Throws
WebBeanException
WebBeanException

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error.

Parameters
out Output by this transform.

public void transformForRequestNotInited (MarkupOutput out)

Transform when the status is Not initialized.

Parameters
out Output by this transform.

Protected Methods

protected WebEvent getCancelEvent ()

Returns
  • WebEvent instance initialized with the information for cancelling a request

protected WebEvent getHistoryListEvent ()

Returns
  • WebEvent instance initialized with the information for the history list

protected WebInboxSource getInboxSource ()

return the WebInboxSource of this session.

Returns
  • the WebInboxSource of this session.

protected RWBean getRWBean ()

Returns the report writing bean being transformed.

Returns
  • The RWBean being transformed.

protected RWFrameBean getRWFrame ()

protected WebEvent getRefreshEvent ()

Returns
  • WebEvent instance initialized with the information for refreshing the request

protected WebEvent getViewDetailsEvent ()

Returns
  • WebEvent instance initialized with the information for going to the details page

protected boolean isDesignMode ()

protected void renderHistoryListButton (MarkupOutput out)

Renders the History List button for the wait page.
It calls getHistoryListEvent() to obtain the event used for the button
The button is not rendered if:
- getHistoryListEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_HISTORY_LIST

Parameters
out output for this transform

protected void renderProcessingInfoDetails (MarkupOutput out)

protected void renderViewDetailsButton (MarkupOutput out)

Renders the View Details button for the wait page.
It calls getViewDetailsEvent() to obtain the event used for the button
The button is not rendered if:
- getViewDetailsEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_VIEW_DETAILS

Parameters
out output for this transform

protected void updateVisTransform (TransformInstance transformInstance, RWObject object)