Package com.microstrategy.web.app.transforms

Class ReportDetailsXHTMLTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class ReportDetailsXHTMLTransform
extends AbstractReportTransform
implements LayoutTransform
    This transform is used to show details of a report. It has details like report name, report path, report SQL, report filters and some other things.
    The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.
    Since:
    MicroStrategy Web 8.0.0

    • Field Detail

      • LEVEL_NAME

        public static final int LEVEL_NAME
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's name.
        Value = 1
        See Also:
        Constant Field Values

      • LEVEL_DESCRIPTION

        public static final int LEVEL_DESCRIPTION
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's description.
        Value = 2
        See Also:
        Constant Field Values

      • LEVEL_OWNER

        public static final int LEVEL_OWNER
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's owner.
        Value = 4
        See Also:
        Constant Field Values

      • LEVEL_ID

        public static final int LEVEL_ID
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's identifier.
        Value = 8
        See Also:
        Constant Field Values

      • LEVEL_SERVER_NAME

        public static final int LEVEL_SERVER_NAME
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the name of the server where the object is located.
        Value = 32
        See Also:
        Constant Field Values

      • LEVEL_PATH

        public static final int LEVEL_PATH
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the path information of where the object is.
        Value = 64
        See Also:
        Constant Field Values

      • LEVEL_ROW_COUNT

        public static final int LEVEL_ROW_COUNT
        Deprecated.
        please use the layout xml instead
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's row count information.
        Value = 128
        See Also:
        Constant Field Values

      • LEVEL_COLUMN_COUNT

        public static final int LEVEL_COLUMN_COUNT
        Deprecated.
        please use the layout xml instead Value = 256
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's column count information.
        See Also:
        Constant Field Values

      • LEVEL_STATUS

        public static final int LEVEL_STATUS
        Deprecated.
        please use the layout xml instead Value = 512
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's status information.
        See Also:
        Constant Field Values

      • LEVEL_REPORT_TYPE

        public static final int LEVEL_REPORT_TYPE
        Deprecated.
        please use the layout xml instead Value = 1024
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's report type.
        See Also:
        Constant Field Values

      • LEVEL_MESSAGE_CREATED

        public static final int LEVEL_MESSAGE_CREATED
        Deprecated.
        please use the layout xml instead Value = 4096
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message created information.
        See Also:
        Constant Field Values

      • LEVEL_MESSAGE_UPDATED

        public static final int LEVEL_MESSAGE_UPDATED
        Deprecated.
        please use the layout xml instead Value = 8192
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message updated information.
        See Also:
        Constant Field Values

      • LEVEL_START_TIME

        public static final int LEVEL_START_TIME
        Deprecated.
        please use the layout xml instead Value = 16384
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's start time information.
        See Also:
        Constant Field Values

      • LEVEL_FINISH_TIME

        public static final int LEVEL_FINISH_TIME
        Deprecated.
        please use the layout xml instead Value = 32768
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's finish time information.
        See Also:
        Constant Field Values

      • LEVEL_MESSAGE_ID

        public static final int LEVEL_MESSAGE_ID
        Deprecated.
        please use the layout xml instead Value = 65536
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message identifier information.
        See Also:
        Constant Field Values

      • LEVEL_REPORT_LIMIT

        public static final int LEVEL_REPORT_LIMIT
        Deprecated.
        please use the layout xml instead Value = 131072
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's limit information.
        See Also:
        Constant Field Values

      • LEVEL_TEMPLATE_NAME

        public static final int LEVEL_TEMPLATE_NAME
        Deprecated.
        please use the layout xml instead Value = 262144
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's template name.
        See Also:
        Constant Field Values

      • LEVEL_REPORT_FILTER

        public static final int LEVEL_REPORT_FILTER
        Deprecated.
        please use the layout xml instead Value = 524288
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's report filter information.
        See Also:
        Constant Field Values

      • LEVEL_VIEW_FILTER

        public static final int LEVEL_VIEW_FILTER
        Deprecated.
        please use the layout xml instead Value = 1048576
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's view filter information.
        See Also:
        Constant Field Values

      • LEVEL_TEMPLATE_DETAILS

        public static final int LEVEL_TEMPLATE_DETAILS
        Deprecated.
        please use the layout xml instead Value = 4194304
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's template details.
        See Also:
        Constant Field Values

      • LEVEL_PROMPT_DETAILS

        public static final int LEVEL_PROMPT_DETAILS
        Deprecated.
        please use the layout xml instead Value = 8388608
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's prompt information.
        See Also:
        Constant Field Values

      • LEVEL_REPORT_SQL

        public static final int LEVEL_REPORT_SQL
        Deprecated.
        please use the layout xml instead Value = 16777216
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's SQL information.
        See Also:
        Constant Field Values

      • LEVEL_BASE_FILTER_NAME

        public static final int LEVEL_BASE_FILTER_NAME
        Deprecated.
        please use the layout xml instead Value = 33554432
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's filter name.
        See Also:
        Constant Field Values

      • LEVEL_ENABLE_TOGGLE_ADVANCED_DETAILS

        public static final int LEVEL_ENABLE_TOGGLE_ADVANCED_DETAILS
        Deprecated.
        please use the layout xml instead Value = 67108864
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display a button for showing or hiding advanced details.
        See Also:
        Constant Field Values

      • LEVEL_MODIFIED

        public static final int LEVEL_MODIFIED
        Deprecated.
        please use the layout xml instead Value = 134217728
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display report's modified information.
        See Also:
        Constant Field Values

      • LEVEL_JOB_ID

        public static final int LEVEL_JOB_ID
        Deprecated.
        please use the layout xml instead Value = 268435456
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's job identifier information.
        See Also:
        Constant Field Values

      • LEVEL_REPORT_DESCRIPTION

        public static final int LEVEL_REPORT_DESCRIPTION
        Deprecated.
        please use the layout xml instead Value = 536870912
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display the report description.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • LEVEL_ALL

        public static final int LEVEL_ALL
        Deprecated.
        please use the layout xml instead Value = 0xfffffff
        Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.
        See Also:
        Constant Field Values

      • FP_LEVEL_FLAG

        public static final java.lang.String FP_LEVEL_FLAG
        Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.
        See Also:
        Constant Field Values

      • levelFlag

        public FormalParameter levelFlag
        Deprecated.
        please use the layout xml instead
        Indicates the level of information to use when displaying the report details.
        The information may include object name, description, row count, sql details and other information. Multiple fields might be rendered at the same time. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_NAME, LEVEL_DESCRIPTION, LEVEL_OWNER, etc.
        Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is LEVEL_ALL

      • reportDetailsTxtAreaRows

        public FormalParameter reportDetailsTxtAreaRows
        Parameter to specify the number of rows for the Report Details TEXTAREA.
        Allowed Values: any integer value

      • reportDetailsTxtAreaCols

        public FormalParameter reportDetailsTxtAreaCols
        Parameter to specify the number of columns for the Report Details TEXTAREA.
        Allowed Values: any integer value

      • sqlTxtAreaRows

        public FormalParameter sqlTxtAreaRows
        Parameter to specify the number of rows for the SQL Textarea.
        Allowed Values: integer values

      • sqlTxtAreaCols

        public FormalParameter sqlTxtAreaCols
        Parameter to specify the number of columns for the SQL Textarea.
        Allowed Values: integer values

      • reportPathStylePara

        public FormalParameter reportPathStylePara
        Parameter to specify the Style name used to show the report path. This has to match one of the styles specified in the page config file.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • expandEmbeddedFilter

        public FormalParameter expandEmbeddedFilter
        This is the formal parameter which will decide if we want to show the embedded filter details or just the embedded filter names.
        Allowed Values: TRUE/FALSE

      • dynamicDateDisplay

        public FormalParameter dynamicDateDisplay
        Since:
        MicroStrategy Web 8.0.2

      • DISPLAY_DYNAMIC_DATES_AS_STATIC

        public static final int DISPLAY_DYNAMIC_DATES_AS_STATIC
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • DISPLAY_DYNAMIC_DATES_AS_DYNAMIC

        public static final int DISPLAY_DYNAMIC_DATES_AS_DYNAMIC
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • TEMPLATE_DETAILS_METRICS

        protected static final java.lang.String TEMPLATE_DETAILS_METRICS
        Key for the template details to identify metric information
        See Also:
        Constant Field Values

      • TEMPLATE_DETAILS_ATTRIBUTES

        protected static final java.lang.String TEMPLATE_DETAILS_ATTRIBUTES
        Key for the template details to identify attribute information
        See Also:
        Constant Field Values

    • Constructor Detail

      • ReportDetailsXHTMLTransform

        public ReportDetailsXHTMLTransform()
        Default no-args constructor

    • Method Detail

      • isReportDetailsAreaVisible

        public boolean isReportDetailsAreaVisible()
        Deprecated.
        use layout xml instead.
        Indicates if the report details section is to be rendered or not. It will depend if at least one of the sections that go on it is requested by the user. By default, any of these should be rendered for the Report Details area to be visible: report filter, template name, template details, view filter, report limit and/or prompt details.
        Returns:
        boolean value indicating if the Report Details section should be rendered or not.

      • isReportAdvancedAreaVisible

        public boolean isReportAdvancedAreaVisible()
        Deprecated.
        please use the layout xml instead.
        Indicates if the Report Advanced Details section is to be rendered or not. It will depend if at least one of the sections taht go on it is requested by the user. By default, any of these should be rendered for the Advanced area to be visible: row count, column count, server name, message identifier, report identifier, message created, message updated and/or level status.
        Returns:
        boolean value indicating if the Advanced section should be rendered or not.

      • isReportAdvancedAreaExpanded

        public boolean isReportAdvancedAreaExpanded()
        Determines based on the formal parameter if the advanced report information are is requested to be expanded or not
        Returns:
        boolean value indicating if the advanced report details area should be shown to the user.

      • renderTemplateNameInformation

        public void renderTemplateNameInformation​(MarkupOutput out)
        Render the template name information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderTemplateDetailsInformation

        public void renderTemplateDetailsInformation​(MarkupOutput out)
        Render the template details information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderReportFilterInformation

        public void renderReportFilterInformation​(MarkupOutput out)
        Render the report filter information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderViewFilterInformation

        public void renderViewFilterInformation​(MarkupOutput out)
        Render the view filter information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderReportLimitInformation

        public void renderReportLimitInformation​(MarkupOutput out)
        Render the report limit information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderPromptSummaryAnswerInformation

        public void renderPromptSummaryAnswerInformation​(MarkupOutput out)
        Render the prompt summary information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getTemplateDetails

        protected void getTemplateDetails​(java.util.Hashtable templateDetails)
        Obtain from the ReportBean instance the template details information
        Parameters:
        templateDetails - Hashtable initialized instance where the information about the template will be saved using the TEMPLATE_DETAILS_METRICS and TEMPLATE_DETAILS_ATTRIBUTES

      • getReportStatus

        public java.lang.String getReportStatus​(int status)
        Extends getReportStatus() by providing custom message for some status
        Overrides:
        getReportStatus in class AbstractReportTransform
        Parameters:
        status - The WebMessage instance current status
        Returns:
        a string description of the status of the message

      • checkLevel

        public boolean checkLevel​(int level)
        Deprecated.
        use layout xml instead.
        Check if the level parameter value contains this flag. This method calls checkLevel(FormalParameter, int) using the levelFlag parameter
        Parameters:
        level - flag value to check
        Returns:
        true means the level flag is included in the levelFlag formal parameter value

      • renderReportName

        public void renderReportName​(MarkupOutput out)
        Render the name information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderTotalRows

        public void renderTotalRows​(MarkupOutput out)
        Render the total rows information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getTotalRows

        public int getTotalRows()
                 throws WebBeanException
        Get the total number of rows information from the ReportBean.
        Returns:
        the total number of rows
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 9.0.0

      • renderTotalColumns

        public void renderTotalColumns​(MarkupOutput out)
        Render the total columns information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getTotalColumns

        public int getTotalColumns()
                    throws WebBeanException
        Get the total number of columns information from the ReportBean.
        Returns:
        the total number of columns
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 9.0.0

      • renderServerName

        public void renderServerName​(MarkupOutput out)
        Render the server name information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getServerName

        public java.lang.String getServerName()
        Get the server name form the ReportBean.
        Returns:
        the server name
        Since:
        MicroStrategy Web 9.0.0

      • renderReportPath

        public void renderReportPath​(MarkupOutput out)
        Render the path location information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderMessageID

        public void renderMessageID​(MarkupOutput out)
        Render the message identifier information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getMessageID

        public java.lang.String getMessageID()
        Get the message identifier from the ReportBean.
        Returns:
        the message identifier
        Since:
        MicroStrategy Web 9.0.0

      • getEncodedMessageID

        public java.lang.String getEncodedMessageID()
        Get the message identifier then encrypt it form layout.
        Returns:
        the message identifier
        Since:
        MicroStrategy Web 9.2.0

      • renderJobID

        public void renderJobID​(MarkupOutput out)
        Render the job identifier information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getJobID

        public java.lang.String getJobID()
        Get the job identifier from ReportBean being displayed.
        Returns:
        the job identifier
        Since:
        MicroStrategy Web 9.0.0

      • renderReportID

        public void renderReportID​(MarkupOutput out)
        Render the identifier information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getReportID

        public java.lang.String getReportID()
        Get the identifier information from the ReportBean being displayed.
        Returns:
        identifier
        Since:
        MicroStrategy Web 9.0.0

      • getEncodedReportID

        public java.lang.String getEncodedReportID()
        Get the identifier information after encoded.
        Returns:
        identifier
        Since:
        MicroStrategy Web 9.2.0

      • renderReportStatus

        public void renderReportStatus​(MarkupOutput out)
        Render the status information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getReportStatus

        public java.lang.String getReportStatus()
        Get the status information from the ReportBean being displayed
        Returns:
        the report status
        Since:
        MicroStrategy Web 9.0.0

      • renderMessageCreated

        public void renderMessageCreated​(MarkupOutput out)
        Render the message created information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getMessageCreationTime

        public java.lang.String getMessageCreationTime()
        Get the message creation time from the ReportBean being displayed
        Returns:
        the message creation time
        Since:
        MicroStrategy Web 9.0.0

      • renderMessageUpdated

        public void renderMessageUpdated​(MarkupOutput out)
        Render the message updated information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getMessageModificationTime

        public java.lang.String getMessageModificationTime()
        Get the message modification time from the ReportBean being displayed.
        Returns:
        the message modification time
        Since:
        MicroStrategy Web 9.0.0

      • renderAdvancedAreaJavaScript

        public void renderAdvancedAreaJavaScript​(MarkupOutput out)
        Renders JavaScript (if any) that will be related with the advanced information area for the report. In this case is for enabling showing and hiding the details.
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • renderAdvancedDetailsButton

        public void renderAdvancedDetailsButton​(MarkupOutput out)
        Render the button that will allow users to show or not the advanced details information about the report.
        Parameters:
        out - the MarkupOutput object
        Since:
        MicroStrategy Web 9.0.0

      • renderAdvancedDetailsButton

        public void renderAdvancedDetailsButton​(MarkupOutput out,
                                        boolean requestExpand)
        Render the button that will allow users to show or not the advanced details information about the report.
        Parameters:
        out - the MarkupOutput instance where the contents of this transform will be saved
        requestExpand - whether the button will be rendered as already expanded or not

      • renderReportType

        public void renderReportType​(MarkupOutput out)
        Render the report type information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getReportType

        public java.lang.String getReportType()
        Get the report type from the ReportBean being displayed.
        Returns:
        the report type
        Since:
        MicroStrategy Web 9.0.0

      • renderStartTime

        public void renderStartTime​(MarkupOutput out)
        Render the start time information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getStartTime

        public java.lang.String getStartTime()
        Get the start time from the ReportBean being displayed.
        Returns:
        the start time
        Since:
        MicroStrategy Web 9.0.0

      • renderFinishTime

        public void renderFinishTime​(MarkupOutput out)
        Render the finish time information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getFinishTime

        public java.lang.String getFinishTime()
        Get the finish time from the ReportBean being displayed.
        Returns:
        the finish time
        Since:
        MicroStrategy Web 9.0.0

      • renderModifiedInformation

        public void renderModifiedInformation​(MarkupOutput out)
        Render the modification information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getModifiedInformation

        public java.lang.String getModifiedInformation()
        Get the modification information from the ReportBean being displayed
        Returns:
        the modification time
        Since:
        MicroStrategy Web 9.0.0

      • renderReportOwner

        public void renderReportOwner​(MarkupOutput out)
        Render the report owner information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getReportOwner

        public java.lang.String getReportOwner()
        Get report owner information from the ReportBean being displayed
        Returns:
        the report owner
        Since:
        MicroStrategy Web 9.0.0

      • renderReportDescription

        public void renderReportDescription​(MarkupOutput out)
        Render the description information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getReportDescription

        public java.lang.String getReportDescription()
        Get the report description from the ReportBean being displayed
        Returns:
        the report description
        Since:
        MicroStrategy Web 9.0.0

      • getReportCube

        public java.lang.String getReportCube()
        Get the report cube for the ReportBean being displayed
        Returns:
        the report description
        Since:
        MicroStrategy Web 9.0.1

      • renderReportSQL

        public void renderReportSQL​(MarkupOutput out)
        Render the SQL information of the ReportBean being displayed
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.

      • getReportSQLLabel

        public java.lang.String getReportSQLLabel()
        Get the report SQL label based on report type.
        Returns:
        the label for report SQL area
        Since:
        MicroStrategy Web 9.0.0

      • getReportSQL

        public java.lang.String getReportSQL()
        Get report SQL from the ReportBean being displayed.
        Returns:
        the report SQL
        Since:
        MicroStrategy Web 9.0.0

      • isReportInError

        public boolean isReportInError()
        Check to see if the report is in error or not.
        Returns:
        true if error occurs; false otherwise
        Since:
        MicroStrategy Web 9.0.0

      • getCssClassName

        public java.lang.String getCssClassName​(java.lang.String cssName)
        Generate the css class name used by this transform.
        Parameters:
        cssName - the css name to be pre-fixed by the _cssPrefix
        Returns:
        complete cssName
        Since:
        MicroStrategy Web 9.0.0

      • getReportDetailAttrs

        public java.util.Map getReportDetailAttrs()
        Collect all the attribute/value(s) to specify the rendering of the report detail text area.
        Returns:
        the attribute/value pair(s)
        Since:
        MicroStrategy Web 9.0.0

      • isReportReady

        public boolean isReportReady()
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderTemplate

        public boolean shouldRenderTemplate()
        Deprecated.
        use layout xml instead.
        Check to see if we should render template.
        Returns:
        true if render if necessary; false otherwise.
        Since:
        MicroStrategy Web 9.0.0

      • renderNewLine

        public void renderNewLine​(MarkupOutput out)
        Render a new line character.
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderPromptDetails

        public boolean shouldRenderPromptDetails()
        Check to see if prompt details should be rendered or not.
        Returns:
        true if necessary;false otherwise
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderAdvancedAreaExpanded

        public boolean shouldRenderAdvancedAreaExpanded()
        check to see if advanced area should be rendered as expanded or not.
        Returns:
        true if necessary;false otherwise
        Since:
        MicroStrategy Web 9.0.0

      • getAdvancedDivId

        public java.lang.String getAdvancedDivId()
        Generate the id of the div that holds the advanced detail information.
        Returns:
        the id
        Since:
        MicroStrategy Web 9.0.0

      • renderReportDetails

        public void renderReportDetails​(MarkupOutput out)
        render new report details.
        Parameters:
        out - MarkupOutput instance where the contents of this transform will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • getReportDetails

        public java.lang.String getReportDetails()
        Get report details from the ReportBean being displayed.
        Returns:
        the report detail string
        Since:
        MicroStrategy Web 9.0.0

      • getExecuteEvent

        protected WebEvent getExecuteEvent​(WebMessage message)
        Returns an event to execute the report.
        Parameters:
        message - the (@link WebMessage} for the ReportBean beings displayed.
        Returns:
        a WebEvent instance to execute the report message. By default it returns the EnumReportBeanEvents.REPORT_EVENT_EXECUTE event, or null if it is not supported by the application

      • getShowDetailsEvent

        protected WebEvent getShowDetailsEvent​(WebMessage message)
        Generate the WebEvent instance to be used for showing the details of the report (to refresh the page information).
        Parameters:
        message - the (@link WebMessage} for the ReportBean beings displayed.
        Returns:
        a WebEvent instance to execute the report message. By default it returns the EnumServletEvents.WebEventGetReportDetails event, or null if it is not supported by the application

      • canTransform

        public boolean canTransform​(Transformable data)
        Overrides canTransform by returning always true. This transform does support showing report details, even if still waiting for prompts.
        Specified by:
        canTransform in interface Transform
        Overrides:
        canTransform in class AbstractReportTransform
        Parameters:
        data - the report bean that will transformed.
        Returns:
        true if the data is a ReportBean.

      • getDescription

        public java.lang.String getDescription()
        Returns the description for this Transform
        Specified by:
        getDescription in interface Transform
        Returns:
        Description for this Transform