Package com.microstrategy.webapi.paramsobject

Class ReportExecuteParams.Builder

  • Enclosing class:
    ReportExecuteParams
    public static class ReportExecuteParams.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • sessionId

        public ReportExecuteParams.Builder sessionId​(java.lang.String sessionId)
        A valid Session ID.
        Parameters:
        sessionId -
        Returns:

      • reportId

        public ReportExecuteParams.Builder reportId​(java.lang.String reportId)
        The ID of the report to run.
        Parameters:
        reportId -
        Returns:

      • executionFlags

        public ReportExecuteParams.Builder executionFlags​(int executionFlags)
        Flags specify different options for the execution. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlags. [Default=DssXmlExecutionUseCache + DssXmlExecutionUpdateCache].
        Parameters:
        executionFlags -
        Returns:

      • executionFlagsExtension

        public ReportExecuteParams.Builder executionFlagsExtension​(int executionFlagsExtension)
        Flags specify different options for the execution extension flags. Value must be a bitwise "or" (addition) of values from EnumDSSXMLExecutionFlagsExtension. [Default=DssExecutionFlagsExtensionReserved].
        Parameters:
        executionFlagsExtension -
        Returns:

      • resultFlags

        public ReportExecuteParams.Builder resultFlags​(int resultFlags)
        Tells the server how to present the results. This value must be a bitwise "or" (addition) of values from EnumDSSXMLResultFlags. [Default=0].
        Parameters:
        resultFlags -
        Returns:

      • promptAnswer

        public ReportExecuteParams.Builder promptAnswer​(java.lang.String promptAnswer)
        Answer to prompt, if any, for the report execution. [Default=""].
        Parameters:
        promptAnswer -
        Returns:

      • viewSetting

        public ReportExecuteParams.Builder viewSetting​(java.lang.String viewSetting)
        XML (containing view index, deltaXML, grid/graph properties) for setting the view of the report. [Default=""].
        Parameters:
        viewSetting -
        Returns:

      • windowSetting

        public ReportExecuteParams.Builder windowSetting​(java.lang.String windowSetting)
        XML (starting row, starting column, max row, max column) for a display window. [Default=""].
        Parameters:
        windowSetting -
        Returns:

      • extParam

        public ReportExecuteParams.Builder extParam​(java.lang.String extParam)
        Indicates any applicable extendable parameters.
        Parameters:
        extParam -
        Returns:

      • requestTimeout

        public ReportExecuteParams.Builder requestTimeout​(int requestTimeout)
        Request timeout value. It is used to override the default session request timeout value for the saving job. By default it's -1.
        Parameters:
        requestTimeout -
        Returns:

      • styleXSL

        public ReportExecuteParams.Builder styleXSL​(java.lang.String styleXSL)
        XSL for the report style. [Default=""].
        Parameters:
        styleXSL -
        Returns:

      • webProperties

        public ReportExecuteParams.Builder webProperties​(java.lang.String webProperties)
        Properties associated with this report. [Default=""].
        Parameters:
        webProperties -
        Returns:

      • subscriptionId

        public ReportExecuteParams.Builder subscriptionId​(java.lang.String subscriptionId)
        ID of subscription if we run the report from subscriptions.
        Parameters:
        subscriptionId -
        Returns: