public abstract class

AbstractDocumentTransform

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.AbstractDocumentTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractDocumentTransform is an abstract class which acts as a super class for all document transforms. All functional document transform classes, such as DocumentDetailsTransform, DocumentSimpleTransform, ... extend from it. Copyright: Copyright (c) 2001

Summary

[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
AbstractDocumentTransform()
Default no argument constructor.
Public Methods
boolean canTransform(Transformable data)
Returns true if the bean is not waiting for user input.
String getDocumentStatus(int status)
Get the document's status as a string representation.
String getErrorMessage(int errorCode, String defaultMessage)
Returns the error message for the transform, based on the exception.
static String getErrorMessageFromMSTRDocumentException(Throwable cause, String newline)
String getErrorTitle(int errorCode)
Returns the error title for the transform, overwrites by returning title specific about document execution.
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 renderErrorButtons(MarkupOutput out, int errorCode, String message)
This method is deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
void renderErrorInfo(MarkupOutput out, int errorCode, String message)
This method is deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
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 when it is still processing results.
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 getContinueEvent()
Returns an event to continue browsing if an error happened.
DocumentBean getDocumentBean()
Returns the documentBean being transformed.
WebEvent getHistoryListEvent()
WebInboxSource getInboxSource()
Returns the InboxSource of this session.
WebEvent getRefreshEvent()
void renderHistoryListButton(MarkupOutput out)
Renders the History List button for the wait page.
void renderProcessingInfoDetails(MarkupOutput out)
[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 AbstractDocumentTransform ()

Default no argument constructor.

Public Methods

public boolean canTransform (Transformable data)

Returns true if the bean is not waiting for user input.

Parameters
data The bean to be transformed.
Returns
  • true if the bean is not waiting for user input.

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 String getErrorMessage (int errorCode, String defaultMessage)

Returns the error message for the transform, based on the exception.
Overwrites by returning either the original message, or if none was provided, an "Error in document results"

Parameters
errorCode The ID of the error.
defaultMessage The error's message.
Returns
  • The error message.

public static String getErrorMessageFromMSTRDocumentException (Throwable cause, String newline)

public String getErrorTitle (int errorCode)

Returns the error title for the transform, overwrites by returning title specific about document execution.

Parameters
errorCode The ID of the error.
Returns
  • The error title.

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

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 renderErrorButtons (MarkupOutput out, int errorCode, String message)

This method is deprecated.
This method is no longer used by the Transform, all the logic is now in the transformForRequestInError

Renders the "continue" or "re-execute" button for the user to continue working after an error occurs.

Parameters
out The transform's output.
errorCode The If of the error.
message The error message

public void renderErrorInfo (MarkupOutput out, int errorCode, String message)

This method is deprecated.
This method is no longer used by the Transform, all the logic is now in the transformForRequestInError

Render the message to display to the user in case there is an error.

Parameters
out The transform's output.
errorCode The ID of the error.
message The error message.

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.
Overwrites by setting the corresponding buttons for Documents.

Parameters
out Output by this transform.

public void renderProcessingInfo (MarkupOutput out)

Renders the information about the bean when it is still processing results.
Overwrites this method by showing information about the 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 getContinueEvent ()

Returns an event to continue browsing if an error happened.

protected DocumentBean getDocumentBean ()

Returns the documentBean being transformed.

Returns

protected WebEvent getHistoryListEvent ()

protected WebInboxSource getInboxSource ()

Returns the InboxSource of this session.

Returns
  • The InboxSource of this session.

protected WebEvent getRefreshEvent ()

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

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)