Package com.microstrategy.web.objects

Interface WebReportManipulation

  • All Superinterfaces:
    WebResultSetManipulation
    public interface WebReportManipulation
extends WebResultSetManipulation
    The report manipulation interface allows the user to apply a set of manipulations to the associated report instance. This interface is obtained from, and connected to, a WebReportInstance object. In addition, this interface contains many methods relating to derived metric manipulations.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getAcceptSQLManipulation

        boolean getAcceptSQLManipulation()
        Returns the value of the acceptSQLManipulation flag. This flag determines whether to allow the Intelligence Server to perform a SQL manipulation in response to an applyChanges call. By default, this flag is true.
        Returns:
        The current value of the acceptSQLManipulation flag.
        See Also:
        setAcceptSQLManipulation(boolean)

      • setAcceptSQLManipulation

        void setAcceptSQLManipulation​(boolean acceptSQLManipulation)
        Sets the value of the acceptSQLManipulation flag. This flag determines whether to allow the Intelligence Server to perform a SQL manipulation in response to an applyChanges call.
        Parameters:
        acceptSQLManipulation - The new value for the acceptSQLManipulation flag.
        See Also:
        getAcceptSQLManipulation()

      • applyChanges

        WebReportInstance applyChanges()
                        throws WebObjectsException,
                               WebReportValidationException
        Sends all changes to the template and filter to the Intelligence Server. Returns a WebReportInstance object. The returned object will be the same as the object which applyChanges was called upon, with the difference of the state ID being increased by 1, if it was not necessary to generate a new report instance. If a new report instance was necessary (i.e. the report changes caused SQL generation), then this method will return a new WebReportInstance object with the new message ID. Finally, note that this method will update the manipulation type and validation level properties on this object.
        Returns:
        The resultant WebReportInstance object from applying the changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • applyChanges

        WebReportInstance applyChanges​(java.lang.String deltaXML)
                        throws WebObjectsException,
                               WebReportValidationException
        Sends the given report manipulation XML to the Intelligence Server. Returns a WebReportInstance object. The returned object will be the same as the object which applyChanges was called upon, with the difference of the state ID being increased by 1, if it was not necessary to generate a new report instance. If a new report instance was necessary (i.e. the report changes caused SQL generation), then this method will return a new WebReportInstance object with the new message ID. Finally, note that this method will update the manipulation type and validation level properties on this object.
        Parameters:
        deltaXML - The report manipulation delta XML to send to the Intelligence Server.
        Returns:
        The resultant WebReportInstance object from applying the changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • applyChanges

        WebReportInstance applyChanges​(java.lang.String deltaXML,
                               int requestTimeout)
                        throws WebObjectsException,
                               WebReportValidationException
        Sends the given report manipulation XML to the Intelligence Server. Returns a WebReportInstance object. The returned object will be the same as the object which applyChanges was called upon, with the difference of the state ID being increased by 1, if it was not necessary to generate a new report instance. If a new report instance was necessary (i.e. the report changes caused SQL generation), then this method will return a new WebReportInstance object with the new message ID. Finally, note that this method will update the manipulation type and validation level properties on this object.
        Parameters:
        deltaXML - The report manipulation delta XML to send to the Intelligence Server.
        requestTimeout - The session request timeout value. It is used to override the default session request timeout.
        Returns:
        The resultant WebReportInstance object from applying the changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • applyChanges

        WebReportInstance applyChanges​(java.lang.String deltaXML,
                               int requestTimeout,
                               StringWrapper resultXML)
                        throws WebObjectsException,
                               WebReportValidationException
        Sends the given report manipulation XML to the Intelligence Server. Returns a WebReportInstance object. The returned object will be the same as the object which applyChanges was called upon, with the difference of the state ID being increased by 1, if it was not necessary to generate a new report instance. If a new report instance was necessary (i.e. the report changes caused SQL generation), then this method will return a new WebReportInstance object with the new message ID. Finally, note that this method will update the manipulation type and validation level properties on this object.
        Parameters:
        deltaXML - The report manipulation delta XML to send to the Intelligence Server.
        requestTimeout - The session request timeout value. It is used to override the default session request timeout.
        resultXML - The manipulation result XML returned
        Returns:
        The resultant WebReportInstance object from applying the changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • getReportProperties

        WebProperties getReportProperties()
        Return current setting for WebProperties. Its default one is from WebReportSource (TBD). If there is no setting, an empty WebProperties object will be return. Then through WebProperties interface, property can be added/removed/changed. The properties in this WebProperties object will be used when re-execute the report.?
        Returns:
        the current WebProperties in this instance.

      • getGraphProperties

        WebGraphProperties getGraphProperties()
        Return a WebGraphProperties object, which can be used to set the web graph properties. The user can use the methods exposed by WebGraphProperties interface to add and manipulate the properties inside it.
        Returns:
        Return a WebGraphProperties object to represent current settings of WebGraphProperties.

      • isInstanceModified

        boolean isInstanceModified()
                    throws WebObjectsException
        This method will return whether the submission of the changes to the report instance so far will cause a new report instance to be created. Note that this method will NOT cause the actual execution of the changes made to the report instance. This method will also update the manipulation type and validation level properties with more information on the type of change that the operation would cause.
        Specified by:
        isInstanceModified in interface WebResultSetManipulation
        Returns:
        Whether the report instance change submission would cause a new report instance to be created.
        Throws:
        WebObjectsException - Thrown if the server could not be contacted or another fatal error occurs.

      • getDeltaXML

        java.lang.String getDeltaXML()
                      throws WebObjectsException
        Returns the delta XML which would be sent to the Intelligence Server upon calling applyChanges(). This XML will be derived from the changes made to the template and filters of the owner report instance.
        Specified by:
        getDeltaXML in interface WebResultSetManipulation
        Returns:
        The delta XML string for the current state of the report instance.
        Throws:
        WebObjectsException - Signals that the delta XML could not be determined.

      • requiresNewInstance

        boolean requiresNewInstance()
                     throws WebObjectsException
        Determines whether the changes made to the filter and template of this report will cause a new report instance (and thus, a reexecution of SQL).
        Specified by:
        requiresNewInstance in interface WebResultSetManipulation
        Returns:
        True if the changes made will cause a reexecution of SQL, false if they will not cause SQL to be executed.
        Throws:
        WebObjectsException - Signals an error when contacting the Intelligence Server.

      • getManipulationType

        int getManipulationType()
        Returns the manipulation type of a submission of changes to a report instance. This variable is updated after calling applyChanges or requiresNewInstance. The return value comes from EnumDSSXMLManipulationType.
        Returns:
        The manipulation type of the last report manipulation sent to the Intelligence Server.

      • getValidationLevel

        int getValidationLevel()
        Returns the validation level of a submission of changes to a report instance. This variable is updated after calling applyChanges or requiresNewInstance. The return value comes from EnumDSSXMLValidationLevel.
        Returns:
        The validation level of the last report manipulation sent to the Intelligence Server.

      • getNewPercentToTotalMetric

        WebPercentToTotalMetric getNewPercentToTotalMetric​(WebMetric metric)
                                            throws java.lang.IllegalArgumentException,
                                                   WebObjectsException
        Returns a new instance of the WebPercentToTotalMetric object. This derived metric is based on the specified metric on the template or working set.
        Parameters:
        metric - The WebMetric object used to create the derived metric.
        Returns:
        the WebPercentToTotalMetric object created.
        Throws:
        java.lang.IllegalArgumentException - thrown if the metric is null or does not exist in the template or in the working set.
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.

      • getNewRankMetric

        WebRankMetric getNewRankMetric​(WebMetric metric)
                        throws java.lang.IllegalArgumentException,
                               WebObjectsException
        Returns a new instance of the WebRankMetric object. This derived metric is based on the specified metric on the template or working set.
        Parameters:
        metric - The WebMetric object used to create the derived metric.
        Returns:
        The WebRankMetric object created.
        Throws:
        java.lang.IllegalArgumentException - thrown if the metric is null or does not exist in the template or in the working set.
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.

      • getNewTransformationMetric

        WebTransformationMetric getNewTransformationMetric​(WebMetric metric,
                                                   WebObjectInfo transformationRole)
                                            throws java.lang.IllegalArgumentException,
                                                   WebObjectsException
        Returns a new instance of the WebTransformationMetric object. This derived metric is based on the specified metric on the template or working set.
        Parameters:
        metric - The WebMetric object used to create the derived metric.
        transformationRole - a WebObjectInfo object that should have a type of DssXmlTypeRole and a subtype of DssXmlSubTypeRoleTransformation from EnumDSSXMLObjectSubTypes.
        Returns:
        The WebTransformationMetric object created.
        Throws:
        java.lang.IllegalArgumentException - thrown if the metric is null or does not exist in the template or in the working set. Also thrown if the transformation role object does not have the correct type and subtype.
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.

      • addDerivedMetric

        WebReportInstance addDerivedMetric​(java.lang.String formulae,
                                   int position)
                            throws WebObjectsException,
                                   WebReportValidationException
        Adds a new derived metric to the report. This method will call addDerivedMetric with the same parameters but adding an empty alias name.
        Parameters:
        formulae - The formula of the derived metric that can be understood by the parser.
        position - The position for the metric on the metrics template unit.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • addDerivedMetric

        WebReportInstance addDerivedMetric​(java.lang.String formulae,
                                   int position,
                                   java.lang.String alias)
                            throws WebObjectsException,
                                   WebReportValidationException
        Adds a new derived metric to the report.
        Parameters:
        formulae - The formula of the derived metric that can be understood by the parser.
        position - The position for the metric on the metrics template unit.
        alias - The display name for the metric.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • addDerivedMetric

        WebReportInstance addDerivedMetric​(java.lang.String formulae,
                                   int position,
                                   java.lang.String alias,
                                   java.lang.Boolean aggFromBase)
                            throws WebObjectsException,
                                   WebReportValidationException
        Adds a new derived metric to the report.
        Parameters:
        formulae - The formula of the derived metric that can be understood by the parser.
        position - The position for the metric on the metrics template unit.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • addDerivedMetric

        WebReportInstance addDerivedMetric​(java.lang.String formulae,
                                   int position,
                                   java.lang.String alias,
                                   int aggFromBase,
                                   int stFromBase,
                                   java.lang.Boolean isTokenStream)
                            throws WebObjectsException,
                                   WebReportValidationException
        Adds a new derived metric to the report.
        Parameters:
        formulae - The formula of the derived metric that can be understood by the parser.
        position - The position for the metric on the metrics template unit.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        stFromBase - flag to indicate whether the metric should subtotal from base.
        isTokenStream - flag to indicate whether the formula is a token stream.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.

      • changeDerivedMetricAggFromBase

        WebReportInstance changeDerivedMetricAggFromBase​(java.lang.String formulae,
                                                 int position,
                                                 java.lang.String alias,
                                                 java.lang.Boolean aggFromBase)
                                          throws WebObjectsException,
                                                 WebReportValidationException
        This changes the formula or alias of the derived metric. If the key of the metric that is passed in does not correspond to a derived metric and a formula is passed in, then the existing metric is replaced by a derived metric with the given formula and alias
        Parameters:
        key - key of the metric for which changes need to be made. The key can be obtained using WebTemplateMetric.getKey()
        formula - The formula of the derived metric that can be understood by the parser.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException
        WebReportValidationException

      • changeDerivedMetricAggFromBase

        WebReportInstance changeDerivedMetricAggFromBase​(java.lang.String formulae,
                                                 int position,
                                                 java.lang.String alias,
                                                 java.lang.Boolean aggFromBase,
                                                 java.lang.Boolean isTokenStream)
                                          throws WebObjectsException,
                                                 WebReportValidationException
        This changes the formula or alias of the derived metric. If the key of the metric that is passed in does not correspond to a derived metric and a formula is passed in, then the existing metric is replaced by a derived metric with the given formula and alias
        Parameters:
        key - key of the metric for which changes need to be made. The key can be obtained using WebTemplateMetric.getKey()
        formula - The formula of the derived metric that can be understood by the parser.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        isTokenStream - flag to indicate whether the formula is a token stream.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException
        WebReportValidationException

      • changeDerivedMetric

        WebReportInstance changeDerivedMetric​(int key,
                                      java.lang.String formula,
                                      java.lang.String alias)
                               throws WebObjectsException,
                                      WebReportValidationException
        This changes the formula or alias of the derived metric. If the key of the metric that is passed in does not correspond to a derived metric and a formula is passed in, then the existing metric is replaced by a derived metric with the given formula and alias
        Parameters:
        key - key of the metric for which changes need to be made. The key can be obtained using WebTemplateMetric.getKey()
        formula - The formula of the derived metric that can be understood by the parser.
        alias - The display name for the metric.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException
        WebReportValidationException
        Since:
        MicroStrategy Web 8.0.0

      • changeDerivedMetric

        WebReportInstance changeDerivedMetric​(int key,
                                      java.lang.String formula,
                                      java.lang.String alias,
                                      java.lang.Boolean aggFromBase)
                               throws WebObjectsException,
                                      WebReportValidationException
        This changes the formula or alias of the derived metric. If the key of the metric that is passed in does not correspond to a derived metric and a formula is passed in, then the existing metric is replaced by a derived metric with the given formula and alias
        Parameters:
        key - key of the metric for which changes need to be made. The key can be obtained using WebTemplateMetric.getKey()
        formula - The formula of the derived metric that can be understood by the parser.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException
        WebReportValidationException

      • changeDerivedMetric

        WebReportInstance changeDerivedMetric​(int key,
                                      java.lang.String formula,
                                      java.lang.String alias,
                                      int aggFromBase,
                                      int stFromBase,
                                      java.lang.Boolean isTokenStream)
                               throws WebObjectsException,
                                      WebReportValidationException
        This changes the formula or alias of the derived metric. If the key of the metric that is passed in does not correspond to a derived metric and a formula is passed in, then the existing metric is replaced by a derived metric with the given formula and alias
        Parameters:
        key - key of the metric for which changes need to be made. The key can be obtained using WebTemplateMetric.getKey()
        formula - The formula of the derived metric that can be understood by the parser.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        stFromBase - flag to indicate whether the metric should subtotal from base.
        isTokenStream - flag to indicate whether the formula is a token stream.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException
        WebReportValidationException

      • changeDerivedMetric

        WebReportInstance changeDerivedMetric​(java.lang.String objectID,
                                      java.lang.String formula,
                                      java.lang.String alias,
                                      int aggFromBase,
                                      int stFromBase,
                                      java.lang.Boolean isTokenStream,
                                      boolean isPassThrough)
                               throws WebObjectsException,
                                      WebReportValidationException
        This changes the formula or alias of the derived metric.
        Parameters:
        objectID - The DSS ID of the metric for which changes need to be made.
        formula - The formula of the derived metric that can be understood by the parser.
        alias - The display name for the metric.
        aggFromBase - flag to indicate whether the metric should aggregate from base.
        stFromBase - flag to indicate whether the metric should subtotal from base.
        isTokenStream - flag to indicate whether the formula is a token stream.
        Returns:
        A WebReportInstance object with the applied changes.
        Throws:
        WebObjectsException
        WebReportValidationException

      • showAllThresholds

        WebReportInstance showAllThresholds​(boolean show,
                                    WebMetric metric)
                             throws java.lang.IllegalArgumentException,
                                    WebObjectsException,
                                    WebReportValidationException
        Show all thresholds for a specific metric.
        Parameters:
        show - true to show thresholds, false to hide thresholds.
        metric - the WebMetric object, whose thresholds will be affected.
        Returns:
        The resultant WebReportInstance object
        Throws:
        WebObjectsException - Signals an error when sending the changes to the Intelligence Server.
        WebReportValidationException - Signals a report validation error from the Intelligence Server.
        java.lang.IllegalArgumentException - if parameter metric is null

      • getResultWindow

        WebResultWindow getResultWindow()
        Returns the result window which can be used to set the result window to be passed to the Intelligence server upon calling applyChanges.
        Returns:
        The WebResultWindow object which can be used to send a window to the Server upon calling the applyChanges.

      • resetChanges

        WebReportInstance resetChanges()
        Return a new WebReportInstance WebReportInstance which is the same as this report instance, except that the returned report instsance does not have any manipulation having been done for this report instance. This is an opposite operation of applyChanges(). The returned WebReportInstance is identical to current WebReportInstance, except that all manipulations have been cleared.
        Returns:
        WebReportInstance A new WebReportInstance.

      • getExecutionFlags

        int getExecutionFlags()
        Returns the current setting of execution flags. This flag value tells the Intelligence Server the settings to use when executing a report.
        Returns:
        The current execution flags, from EnumDSSXMLExecutionFlags.
        See Also:
        setExecutionFlags(int)

      • setExecutionFlags

        void setExecutionFlags​(int executionFlags)
        Sets the execution flags property. This flag value tells the Intelligence Server the settings to use when executing a report.
        Parameters:
        executionFlags - The new value of execution flags, a value which is the bitwise or (|) from values in EnumDSSXMLExecutionFlags.
        See Also:
        getExecutionFlags()

      • getExecutionFlagsExtension

        int getExecutionFlagsExtension()
        Returns the current setting of execution flags extension. This flag value tells the Intelligence Server the settings to use when executing a report.
        Returns:
        The current execution flags extension, form EnumDSSXMLExecutionFlagsExtension.
        See Also:
        setExecutionFlagsExtension(int)

      • setExecutionFlagsExtension

        void setExecutionFlagsExtension​(int executionFlagsExtension)
        Sets the execution flags extension property. This flag value tells the Intelligence Server the settings to use when executing a report.
        Parameters:
        executionFlagsExtension - The new value of execution flags extension, a value which is the bitwise or (|) from values in EnumDSSXMLExecutionFlagsExtension
        See Also:
        getExecutionFlagsExtension()

      • getPreviewRows

        int getPreviewRows()
        Returns the number of preview rows. This field value tells the Intelligence Server to use the number of rows for data preview.
        Returns:
        The number of rows of preview data.
        See Also:
        setPreviewRows(int)

      • setPreviewRows

        void setPreviewRows​(int previewRows)
        Sets the number of preview rows. This field value tells the Intelligence Server the set the number of rows for data preview.
        Parameters:
        previewRows - The number of rows of preview data.
        See Also:
        getPreviewRows()

      • getResultFlags

        int getResultFlags()
        Returns the result flags which will be sent upon calling applyChanges.
        Returns:
        The result flag value sent upon calling applyChanges. This will be the bitwise or (|) of values from EnumDSSXMLResultFlags.
        See Also:
        setResultFlags(int)

      • setResultFlags

        void setResultFlags​(int resultFlags)
        Allows the user to set the result flags which will be sent upon calling applyChanges.
        Parameters:
        resultFlags - The result flags which will be used upon calling applyChanges, from the bitwise or (|) of values from EnumDSSXMLResultFlags.
        See Also:
        getResultFlags()

      • drill

        WebReportInstance drill​(java.lang.String drillKey,
                        java.lang.String[] drillElements,
                        java.util.Map drillProperties)
                 throws WebObjectsException
        Drills on the current report instance using the drill path key and settings passed as arguments.
        Parameters:
        drillKey - This is the key to the drill path to be used for drilling. The drill key can be obtained from WebDrillPath.getKey()
        drillElements - This is a string array of the drill elements representing the user filter. Each drill element is represented by an identifier (String) that can be obtained from WebHeader.getDrillElement()
        drillProperties - This should be a map of drill settings that the user wants to override while drilling. The keys in the map should be from EnumWebDrillProperties. Based on the type of drill property (int/boolean), following are the object types that can be passed as values in the Map :
        [1] For a drill property that can have integer values, an Integer or String object, wrapping the (integer) value, should be set.
        [2] For a drill property that can have only boolean values, a Boolean or String object representing the (boolean) value should be set. The String object should have values {"true", "false", "1", "0"} only.
        Returns:
        the new instance upon drilling.
        Throws:
        WebObjectsException - signal error encountered by IServer while executing the drill.
        Since:
        MicroStrategy Web 8.0.0

      • refresh

        WebReportInstance refresh​(boolean rePrompt)
                   throws WebObjectsException
        refreshes the report results.
        Parameters:
        rePrompt - should be sent to true, if prompts need to be re-answered.
        Returns:
        new report instance upon refresh.
        Throws:
        WebObjectsException - thrown if server encountered an error while refreshing the results.
        Since:
        MicroStrategy Web 8.0.0

      • refresh

        WebReportInstance refresh​(boolean rePrompt,
                          IntWrapper jobId)
                   throws WebObjectsException
        refreshes the report results which updates the jobId.
        Parameters:
        rePrompt - should be sent to true, if prompts need to be re-answered.
        jobId - the jobId of IServer job
        Returns:
        new report instance upon refresh.
        Throws:
        WebObjectsException

      • refresh

        WebReportInstance refresh​(java.lang.String promptAnswerXML)
                   throws WebObjectsException
        refreshes the report results.
        Parameters:
        promptAnswerXML - the answer xml for the prompts.
        Returns:
        new report instance upon refresh.
        Throws:
        WebObjectsException - thrown if server encountered an error while refreshing the results.

      • validateExpression

        java.lang.String validateExpression​(java.lang.String tokenStreamXML,
                                    boolean isForMetric,
                                    int outFlags,
                                    int baseFormType)
                             throws WebObjectsException
        Throws:
        WebObjectsException

      • changeEmmaSourceTablesExecutionAction

        WebReportInstance changeEmmaSourceTablesExecutionAction​(java.util.Map<java.lang.String,​java.lang.Integer> tbs)
                                                 throws WebObjectsException,
                                                        WebReportValidationException
        Change EMMA source tables execution action flags EnumDSSXMLTableStateExecutionAction according to the policy, suggest to pass all the source tables with its policy together.

        For the tables we changed their policy, we will set it's action to Force Execution.

        For the tables we ignored, we will set it's action to Ignore.,

        Parameters:
        tbs - Key indicates source table IDs, and Value indicates execution action EnumDSSXMLCubeRefreshType
        Returns:
        the new instance
        Throws:
        WebObjectsException
        WebReportValidationException

      • setDataImportInfo

        WebReportInstance setDataImportInfo​(java.lang.String tbID,
                                    java.lang.String dbRoleID,
                                    java.lang.String sourceAccountID,
                                    java.lang.String url,
                                    java.lang.String userDisplayName,
                                    java.lang.String reportAddress,
                                    java.lang.String reportDesc,
                                    java.lang.String reportMimetype,
                                    java.lang.String reportName,
                                    java.lang.String shtIx,
                                    java.lang.String fileType,
                                    java.lang.String sparkURL)
                             throws WebObjectsException,
                                    WebReportValidationException
        set DataImportInfo
        Parameters:
        tbID -
        dbRoleID -
        sourceAccountID -
        url -
        userDisplayName -
        reportAddress -
        reportDesc -
        reportMimetype -
        reportName -
        shtIx -
        fileType -
        sparkURL -
        Returns:
        the new instance
        Throws:
        WebObjectsException
        WebReportValidationException

      • editEMMASourceTable

        WebReportInstance editEMMASourceTable​(java.lang.String srcTableID,
                                      java.lang.String tableName,
                                      java.lang.String tableFormatLeft,
                                      java.lang.String tableFormatTop,
                                      java.lang.String tableFormatWidth,
                                      java.lang.String tableFormatHeight,
                                      java.lang.String executionFlag,
                                      java.lang.String isImportBinary,
                                      java.lang.String refreshType)
                               throws WebObjectsException,
                                      WebReportValidationException
        edit editEMMASourceTable
        Parameters:
        srcTableID -
        tableName -
        tableFormatLeft -
        tableFormatTop -
        tableFormatWidth -
        tableFormatHeight -
        executionFlag -
        isImportBinary -
        refreshType -
        Returns:
        the new instance
        Throws:
        WebObjectsException
        WebReportValidationException

      • applyChangeForReplaceObjects

        WebReportInstance applyChangeForReplaceObjects​(java.util.List<org.apache.commons.lang3.tuple.Pair<WebObjectInfo,​WebObjectInfo>> listOfWebObjectsToReplace,
                                               int clearAlias,
                                               int clearFormats,
                                               int clearFilter)
                                        throws WebObjectsException,
                                               WebReportValidationException
        Creates XML request either to remove or replace objects from different data source. clr_a: controls whether to clear the alias. Default value is 0. If it is set to non-zero value, then during reconciliation, server will clear alias from template attribute and template metric. clr_f: controls whether to clear the formats. Default value is 0. If it is set to non-zero value, then during reconciliation, server will clear both grid and header formats from template attribute and template metric. clr_fs: controls whether to clear the expression from view filter or metric limit. Default value is 1. If non-zero value is passed or the parameter is not passed, server will try to clear a part of the expression from the view filter or metric limit if the expression is going to be changed.
        Parameters:
        listOfWebObjectsToReplace - List of pair containing source WebObjectInfo, target WebObjectInfo
        clearAlias - clr_a: controls whether to clear the alias. Default value is 0. If it is set to non-zero value, then during reconciliation, server will clear alias from template attribute and template metric.
        clearFormats - clr_f: controls whether to clear the formats. Default value is 0. If it is set to non-zero value, then during reconciliation, server will clear both grid and header formats from template attribute and template metric.
        clearFilter - controls whether to clear the expression from view filter or metric limit. Default value is 1. If non-zero value is passed or the parameter is not passed, server will try to clear a part of the expression from the view filter or metric limit if the expression is going to be changed.
        Returns:
        Throws:
        WebObjectsException
        WebReportValidationException