public class

DocumentFastExportTransform

extends AbstractDocumentTransform
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
             ↳ com.microstrategy.web.app.transforms.DocumentFastExportTransform

Class Overview

DocumentFastExportTransform is the class that generates the output for a DocumentBean before fast exporting

Summary

Constants
String FP_EVENT_SET_ARGUMENTS
String FP_EVENT_TO_FORWARD_TO
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter eventToForwardTo This is the ID of the event to be executed by the HTML form to be rendered and submitted automatically by this Transform.
public FormalParameter setEventArguments Defines if the arguments of the event specified in the formal parameter eventToForwardTo should be set or not.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DocumentFastExportTransform()
Default no argument constructor.
Public Methods
String getDescription()
Return description for this Transform.
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
WebEvent setEventArgumentsFromRequestKeys(WebEvent event, RequestKeys rk)
Checks for all the parameters on the request keys and if they are arguments of the event, it asigns the value of the parameter to the event's argument Note: if none of the request's parameters are arguments of teh event it returns the original event
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
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

Constants

public static final String FP_EVENT_SET_ARGUMENTS

Constant Value: "setEventArguments"

public static final String FP_EVENT_TO_FORWARD_TO

Constant Value: "eventToForwardTo"

Fields

public FormalParameter eventToForwardTo

This is the ID of the event to be executed by the HTML form to be rendered and submitted automatically by this Transform.
This transform allows a page including document beans to be fully processed before redirecting the user request to the next page, which will be indicated by the event ID defined on this formal parameter. Typically this event will be a servlet event with a target attribute, so that we can redirect to the page specified as the target.

public FormalParameter setEventArguments

Defines if the arguments of the event specified in the formal parameter eventToForwardTo should be set or not.
If this value is set to true, we will parse the request keys and look for any argument names which are acceptable by the eventToForwardTo event, and if we find any, we will set them on the event.

Public Constructors

public DocumentFastExportTransform ()

Default no argument constructor.

Public Methods

public String getDescription ()

Return description for this Transform.

Returns
  • The description for this Transform.

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo Output by this transform.

Protected Methods

protected WebEvent setEventArgumentsFromRequestKeys (WebEvent event, RequestKeys rk)

Checks for all the parameters on the request keys and if they are arguments of the event, it asigns the value of the parameter to the event's argument Note: if none of the request's parameters are arguments of teh event it returns the original event

Parameters
event The WebEvent to forward to as specified in the formal parameter eventToForwardTo.
rk The RequestKeys from which we have to set argument values on the event.
Returns
  • The new event with all arguments set.