public interface

WebReportManipulation

implements WebResultSetManipulation
com.microstrategy.web.objects.WebReportManipulation

Class Overview

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.

Summary

Public Methods
abstract WebReportInstance addDerivedMetric(String formulae, int position, String alias, Boolean aggFromBase)
Adds a new derived metric to the report.
abstract WebReportInstance addDerivedMetric(String formulae, int position, String alias, Boolean aggFromBase, boolean isPassThrough)
abstract WebReportInstance addDerivedMetric(String formulae, int position, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream)
Adds a new derived metric to the report.
abstract WebReportInstance addDerivedMetric(String formulae, int position)
Adds a new derived metric to the report.
abstract WebReportInstance addDerivedMetric(String formulae, int position, String alias)
Adds a new derived metric to the report.
abstract WebReportInstance addDerivedMetric(String formulae, int position, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream, boolean isPassThrough)
abstract WebReportInstance addPercentToTotalMetric(WebPercentToTotalMetric metric)
Adds a percent to total metric to the Report.
abstract WebReportInstance addQuickCalculationGroup(String deName, String attId, int depth, int[] ordinals, int function)
This method is deprecated. Use addQuickCalculationGroup(String, String, int, int[], int, WebDerivedElements) instead
abstract WebReportInstance addQuickCalculationGroup(String deName, String attId, int depth, int[] ordinals, int function, WebDerivedElements target)
abstract WebReportInstance addQuickListGroup(String deName, String attId, int depth, int[] ordinals, WebDerivedElements target)
abstract WebReportInstance addQuickListGroup(String deName, String attId, int depth, int[] ordinals)
This method is deprecated. Use addQuickListGroup(String, String, int, int[], WebDerivedElements) instead
abstract WebReportInstance addRankMetric(WebRankMetric metric)
Adds a rank metric to the Report.
abstract WebReportInstance addShortcutMetric(int functionType, int functionType2, List<WebObjectInfo> unitsInfo)
abstract WebReportInstance addTransformationMetric(WebTransformationMetric metric)
Adds a transformation metric to the Report.
abstract WebReportInstance applyChanges(String deltaXML, int requestTimeout, StringWrapper resultXML)
Sends the given report manipulation XML to the Intelligence Server.
abstract WebReportInstance applyChanges()
Sends all changes to the template and filter to the Intelligence Server.
abstract WebReportInstance applyChanges(String deltaXML, int requestTimeout)
Sends the given report manipulation XML to the Intelligence Server.
abstract WebReportInstance applyChanges(String deltaXML)
Sends the given report manipulation XML to the Intelligence Server.
abstract WebReportInstance applyStyleByID(String id)
Apply a style by style DSSID.
abstract WebReportInstance applyStyleByName(String name)
Apply a style by style name.
abstract WebReportInstance changeDerivedMetric(int key, String formula, String alias, Boolean aggFromBase, boolean isPassThrough)
abstract WebReportInstance changeDerivedMetric(String objectID, String formula, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream, boolean isPassThrough)
This changes the formula or alias of the derived metric.
abstract WebReportInstance changeDerivedMetric(int key, String formula, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream, boolean isPassThrough)
abstract WebReportInstance changeDerivedMetric(int key, String formula, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream)
This changes the formula or alias of the derived metric.
abstract WebReportInstance changeDerivedMetric(int key, String formula, String alias)
This changes the formula or alias of the derived metric.
abstract WebReportInstance changeDerivedMetric(int key, String formula, String alias, Boolean aggFromBase)
This changes the formula or alias of the derived metric.
abstract WebReportInstance changeDerivedMetricAggFromBase(String formulae, int position, String alias, Boolean aggFromBase, Boolean isTokenStream)
This changes the formula or alias of the derived metric.
abstract WebReportInstance changeDerivedMetricAggFromBase(String formulae, int position, String alias, Boolean aggFromBase)
This changes the formula or alias of the derived metric.
abstract WebReportInstance changeEmmaSourceTablesExecutionAction(Map<String, Integer> tbs)
Change EMMA source tables execution action flags EnumDSSXMLTableStateExecutionAction according to the policy, suggest to pass all the source tables with its policy together.
abstract WebReportInstance changeEmmaSourceTablesPolicy(Map<String, Integer> tbs)
Change EMMA source tables policy, suggest to pass all the source tables with its policy together
abstract WebReportInstance changeMapping(String tableID, String tableName, List<MappingOperation> mappings)
change mapping
abstract WebReportInstance clearDiscoverCache(String tableId)
clear discover cache
abstract WebReportInstance createPickTable(String tableID, String xdaType, String dict, String tableName, String dbTableName, String nameSpace, String dbrID)
Create pick table
abstract WebReportInstance createPushDataTables(List<String> tableNames)
create pushdatatables
abstract WebReportInstance createSourceTable(String tableId, String tableName, String xdaType, String connectorType)
create table
abstract WebReportInstance customMappingForEmmaSourceTable(String tableName, MappingCreator mappingCreator)
custom mapping for EMMA source table
abstract WebReportInstance customMappingForEmmaSourceTables(List<MappingCreator> mappingCreators)
customMapping for EmmaSourceTables
abstract WebReportInstance drill(String drillKey, String[] drillElements, Map drillProperties)
Drills on the current report instance using the drill path key and settings passed as arguments.
abstract WebReportInstance editEMMASourceTable(String srcTableID, String tableName, String tableFormatLeft, String tableFormatTop, String tableFormatWidth, String tableFormatHeight, String executionFlag, String isImportBinary, String refreshType)
edit editEMMASourceTable
abstract WebReportInstance editEMMASourceTables(JSONArray commands)
edit editEMMASourceTables in batch
abstract WebReportInstance editFreeFormSQL(String expdef, String emmaSourceTableId)
edit FreeFormSQL
abstract WebReportInstance editRelationship(String tableName, List<MappingRelationship> relationships)
edit relationship
abstract WebReportInstance filterOnSelections(String[] drillElements, Map drillProperties)
abstract boolean getAcceptSQLManipulation()
Returns the value of the acceptSQLManipulation flag.
abstract String getDeltaXML()
Returns the delta XML which would be sent to the Intelligence Server upon calling applyChanges().
abstract int getExecutionFlags()
Returns the current setting of execution flags.
abstract WebGraphProperties getGraphProperties()
Return a WebGraphProperties object, which can be used to set the web graph properties.
abstract int getManipulationType()
Returns the manipulation type of a submission of changes to a report instance.
abstract WebPercentToTotalMetric getNewPercentToTotalMetric(WebMetric metric)
Returns a new instance of the WebPercentToTotalMetric object.
abstract WebRankMetric getNewRankMetric(WebMetric metric)
Returns a new instance of the WebRankMetric object.
abstract WebTransformationMetric getNewTransformationMetric(WebMetric metric, WebObjectInfo transformationRole)
Returns a new instance of the WebTransformationMetric object.
abstract WebProperties getReportProperties()
Return current setting for WebProperties.
abstract int getResultFlags()
Returns the result flags which will be sent upon calling applyChanges.
abstract 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.
abstract int getValidationLevel()
Returns the validation level of a submission of changes to a report instance.
abstract boolean isInstanceModified()
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.
abstract WebReportInstance makeTabular()
abstract WebReportInstance raExpandCollapse(String attId, int axis, int ordinal, int depth, boolean expand)
abstract WebReportInstance refresh(boolean rePrompt)
refreshes the report results.
abstract WebReportInstance refresh(String promptAnswerXML)
refreshes the report results.
abstract WebReportInstance refreshEmmaCubeTablesWithExtParam(String extParam)
Refresh EMMA cube with extended parameters@return
abstract boolean requiresNewInstance()
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).
abstract 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.
abstract void setAcceptSQLManipulation(boolean acceptSQLManipulation)
Sets the value of the acceptSQLManipulation flag.
abstract WebReportInstance setCurrentPageByElement(String elementID, int elementStatus, boolean applyChanges)
abstract WebReportInstance setDataImportInfo(String tbID, String dbRoleID, String sourceAccountID, String url, String userDisplayName, String reportAddress, String reportDesc, String reportMimetype, String reportName, String shtIx, String fileType, String sparkURL)
set DataImportInfo
abstract void setExecutionFlags(int executionFlags)
Sets the execution flags property.
abstract void setResultFlags(int resultFlags)
Allows the user to set the result flags which will be sent upon calling applyChanges.
abstract WebReportInstance showAllThresholds(boolean show)
Show all thresholds for all metrics.
abstract WebReportInstance showAllThresholds(boolean show, WebMetric metric)
Show all thresholds for a specific metric.
abstract WebReportInstance syncModel(String modelJSON, int serveMode)
edit syncModel
abstract WebReportInstance syncModel(String modelJSON, int serveMode, List<TableAction> tableActions)
edit syncModel
abstract WebReportInstance toggleDatasetServerMode(int serverMode)
Toggle dataset server mode
abstract String validateExpression(String tokenStreamXML, boolean isForMetric, int outFlags, int baseFormType)
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebResultSetManipulation

Public Methods

public abstract WebReportInstance addDerivedMetric (String formulae, int position, String alias, Boolean aggFromBase)

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
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance addDerivedMetric (String formulae, int position, String alias, Boolean aggFromBase, boolean isPassThrough)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addDerivedMetric (String formulae, int position, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream)

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
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance addDerivedMetric (String formulae, int position)

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
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance addDerivedMetric (String formulae, int position, String alias)

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
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance addDerivedMetric (String formulae, int position, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream, boolean isPassThrough)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addPercentToTotalMetric (WebPercentToTotalMetric metric)

Adds a percent to total metric to the Report.

Parameters
metric the WebPercentToTotalMetric to be added to the report.
Returns
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.
IllegalArgumentException if the metric to be added is null.

public abstract WebReportInstance addQuickCalculationGroup (String deName, String attId, int depth, int[] ordinals, int function)

This method is deprecated.
Use addQuickCalculationGroup(String, String, int, int[], int, WebDerivedElements) instead

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addQuickCalculationGroup (String deName, String attId, int depth, int[] ordinals, int function, WebDerivedElements target)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addQuickListGroup (String deName, String attId, int depth, int[] ordinals, WebDerivedElements target)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addQuickListGroup (String deName, String attId, int depth, int[] ordinals)

This method is deprecated.
Use addQuickListGroup(String, String, int, int[], WebDerivedElements) instead

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addRankMetric (WebRankMetric metric)

Adds a rank metric to the Report.

Parameters
metric the WebRankMetric to be added to the report.
Returns
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.
IllegalArgumentException if the metric to be added is null.

public abstract WebReportInstance addShortcutMetric (int functionType, int functionType2, List<WebObjectInfo> unitsInfo)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance addTransformationMetric (WebTransformationMetric metric)

Adds a transformation metric to the Report.

Parameters
metric the WebTransformationMetric to be added to the report.
Returns
Throws
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.
IllegalArgumentException if the metric to be added is null.

public abstract WebReportInstance applyChanges (String deltaXML, int requestTimeout, StringWrapper resultXML)

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.

public abstract WebReportInstance applyChanges ()

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.

public abstract WebReportInstance applyChanges (String deltaXML, int requestTimeout)

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.

public abstract WebReportInstance applyChanges (String deltaXML)

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.

public abstract WebReportInstance applyStyleByID (String id)

Apply a style by style DSSID.

Parameters
id the DSSID of the style object to be applied.
Returns
Throws
IllegalArgumentException Thrown when id is null or empty string.
WebObjectsException Singals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance applyStyleByName (String name)

Apply a style by style name.

Parameters
name the name of the style to be applied.
Returns
Throws
IllegalArgumentException Thrown when the name is null or empty string.
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance changeDerivedMetric (int key, String formula, String alias, Boolean aggFromBase, boolean isPassThrough)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance changeDerivedMetric (String objectID, String formula, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream, boolean isPassThrough)

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
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance changeDerivedMetric (int key, String formula, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream, boolean isPassThrough)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance changeDerivedMetric (int key, String formula, String alias, int aggFromBase, int stFromBase, Boolean isTokenStream)

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 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
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance changeDerivedMetric (int key, String formula, String alias)

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 getKey()
formula The formula of the derived metric that can be understood by the parser.
alias The display name for the metric.
Returns
Throws
WebObjectsException
WebReportValidationException
WebObjectsException
WebReportValidationException

public abstract WebReportInstance changeDerivedMetric (int key, String formula, String alias, Boolean aggFromBase)

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 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
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance changeDerivedMetricAggFromBase (String formulae, int position, String alias, Boolean aggFromBase, Boolean isTokenStream)

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
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
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance changeDerivedMetricAggFromBase (String formulae, int position, String alias, Boolean aggFromBase)

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
alias The display name for the metric.
aggFromBase flag to indicate whether the metric should aggregate from base.
Returns
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance changeEmmaSourceTablesExecutionAction (Map<String, Integer> tbs)

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
WebObjectsException

public abstract WebReportInstance changeEmmaSourceTablesPolicy (Map<String, Integer> tbs)

Change EMMA source tables policy, suggest to pass all the source tables with its policy together

Parameters
tbs Key indicates source table IDs, and Value indicates policies EnumDSSXMLCubeRefreshType
Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance changeMapping (String tableID, String tableName, List<MappingOperation> mappings)

change mapping

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance clearDiscoverCache (String tableId)

clear discover cache

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance createPickTable (String tableID, String xdaType, String dict, String tableName, String dbTableName, String nameSpace, String dbrID)

Create pick table

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance createPushDataTables (List<String> tableNames)

create pushdatatables

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance createSourceTable (String tableId, String tableName, String xdaType, String connectorType)

create table

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance customMappingForEmmaSourceTable (String tableName, MappingCreator mappingCreator)

custom mapping for EMMA source table

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance customMappingForEmmaSourceTables (List<MappingCreator> mappingCreators)

customMapping for EmmaSourceTables

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance drill (String drillKey, String[] drillElements, Map drillProperties)

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

public abstract WebReportInstance editEMMASourceTable (String srcTableID, String tableName, String tableFormatLeft, String tableFormatTop, String tableFormatWidth, String tableFormatHeight, String executionFlag, String isImportBinary, String refreshType)

edit editEMMASourceTable

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance editEMMASourceTables (JSONArray commands)

edit editEMMASourceTables in batch

Parameters
commands {did: srcTableId, exef: executeAction}
Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance editFreeFormSQL (String expdef, String emmaSourceTableId)

edit FreeFormSQL

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance editRelationship (String tableName, List<MappingRelationship> relationships)

edit relationship

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance filterOnSelections (String[] drillElements, Map drillProperties)

Throws
WebObjectsException

public abstract 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

public abstract String getDeltaXML ()

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.

Returns
  • The delta XML string for the current state of the report instance.
Throws
WebObjectsException Signals that the delta XML could not be determined.

public abstract 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
See Also

public abstract 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

public abstract 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.

public abstract WebPercentToTotalMetric getNewPercentToTotalMetric (WebMetric metric)

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
Throws
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.

public abstract WebRankMetric getNewRankMetric (WebMetric metric)

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
Throws
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.

public abstract WebTransformationMetric getNewTransformationMetric (WebMetric metric, WebObjectInfo transformationRole)

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
Throws
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.

public abstract 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

public abstract 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

public abstract 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.

public abstract 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.

public abstract boolean isInstanceModified ()

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.

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.

public abstract WebReportInstance makeTabular ()

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance raExpandCollapse (String attId, int axis, int ordinal, int depth, boolean expand)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance refresh (boolean rePrompt)

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.

public abstract WebReportInstance refresh (String promptAnswerXML)

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.

public abstract WebReportInstance refreshEmmaCubeTablesWithExtParam (String extParam)

Refresh EMMA cube with extended parameters@return

Throws
WebObjectsException

public abstract boolean requiresNewInstance ()

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).

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.

public abstract 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.

public abstract 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

public abstract WebReportInstance setCurrentPageByElement (String elementID, int elementStatus, boolean applyChanges)

Throws
WebObjectsException
WebReportValidationException

public abstract WebReportInstance setDataImportInfo (String tbID, String dbRoleID, String sourceAccountID, String url, String userDisplayName, String reportAddress, String reportDesc, String reportMimetype, String reportName, String shtIx, String fileType, String sparkURL)

set DataImportInfo

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract 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

public abstract 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

public abstract WebReportInstance showAllThresholds (boolean show)

Show all thresholds for all metrics.

Parameters
show true to show all thresholds for all metrics, false to hide the thresholds for all metrics
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.

public abstract WebReportInstance showAllThresholds (boolean show, WebMetric metric)

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.
IllegalArgumentException if parameter metric is null

public abstract WebReportInstance syncModel (String modelJSON, int serveMode)

edit syncModel

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance syncModel (String modelJSON, int serveMode, List<TableAction> tableActions)

edit syncModel

Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract WebReportInstance toggleDatasetServerMode (int serverMode)

Toggle dataset server mode

Parameters
serverMode EnumDSSXMLDatasetServeMode
Returns
  • the new instance
Throws
WebObjectsException
WebReportValidationException
WebObjectsException

public abstract String validateExpression (String tokenStreamXML, boolean isForMetric, int outFlags, int baseFormType)

Throws
WebObjectsException