Class DocumentFastExportTransform

  • All Implemented Interfaces:
    AppTransform, Transform

    public class DocumentFastExportTransform
    extends AbstractDocumentTransform
    DocumentFastExportTransform is the class that generates the output for a DocumentBean before fast exporting
    MicroStrategy Web 7.3.1 or earlier
    • Field Detail

      • eventToForwardTo

        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.
      • setEventArguments

        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 static final java.lang.String FP_EVENT_TO_FORWARD_TO
        See Also:
        Constant Field Values

        public static final java.lang.String FP_EVENT_SET_ARGUMENTS
        See Also:
        Constant Field Values
    • Constructor Detail

      • DocumentFastExportTransform

        public DocumentFastExportTransform()
        Default no argument constructor.
    • Method Detail

      • setEventArgumentsFromRequestKeys

        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
        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.
        The new event with all arguments set.
      • getDescription

        public java.lang.String getDescription()
        Return description for this Transform.
        The description for this Transform.