public interface

WebReportSource

com.microstrategy.web.objects.WebReportSource

Class Overview

The WebReportSource interface allows the user to execute and retrieve report instances, along with giving access to many objects which have a supplemental usage in report execution. All report instances returned from this interface will have default result flag as EnumDSSXMLResultFlags.DssXmlResultPreserve bitwise or (|) EnumDSSXMLResultFlags.DssXmlResultNoDerivedPromptXML.

Summary

Public Methods
abstract WebReportInstance changeImportedCube(int sheetIndex, String colHeaders, String reportID, String msgID, boolean isUrl, String transformations)
Change the sheet index or insert new column headers on a imported cube@return
abstract WebReportInstance changeImportedCube(int sheetIndex, String colHeaders, String reportID, String msgID, boolean isUrl, String transformations, String dbRoleID, String sourceAccountID, int behaviorFlags)
Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags@return
abstract WebReportInstance changeImportedCube(int sheetIndex, String colHeaders, String reportID, String msgID, boolean isUrl, String transformations, String dbRoleID, String sourceAccountID, int behaviorFlags, String documentID)
Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags@return
abstract String getBinaryFileContent(PostedFile fileInfo, int maxNumElements, boolean preserveWhiteSpace, String outputDelimiter)
get the contents from binary file
abstract String getDIProjectSettings(int settingID)
get the Data import related project settings.
abstract WebElementSource getElementSource(String messageID)
Returns a WebElementSource object which can be used to get elements within the working set of the given report.
abstract int getExecutionFlags()
Returns the current setting for the execution flags, which will be used when submitting a report for execution to the Intelligence Server.
abstract WebReportExportSettings getExportSettings(int executionMode)
Returns WebReportExportSettings which can be used to define the type of export and the various parameters for the export
abstract WebGraphProperties getGraphProperties()
Return a WebGraphProperties object, which can be used to set the web graph properties.
abstract WebReportInstance getInstance(String messageID)
Returns a WebReportInstance representing the report execution with the given message ID.
abstract WebReportInstance getInstance(String messageID, int stateID)
Returns a WebReportInstance representing the report execution with the given message ID and state ID.
abstract WebReportInstance getInstanceFromRWDrill(RWDrill2ReportSettings drillSettings)
Create a report instance based on the drill from a document.
abstract WebReportInstance getInstanceFromSchedule(WebSchedule schedule)
This method is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use getInstanceFromSubscription(WebSubscription) instead.
abstract WebReportInstance getInstanceFromState(SAXSupport parser, String uri, String local, String qName, Attributes attrs)
Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().
abstract WebReportInstance getInstanceFromState(String savedStateStr)
Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().
abstract WebReportInstance getInstanceFromSubscription(WebSubscription subscription)
Create a report instance based on the subscription object.
abstract WebReportInstance getNewInstance(String reportID)
Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.
abstract WebReportInstance getNewInstance()
Generates a report instance by executing what is considered to be the "new report" report in metadata.
abstract WebReportInstance getNewInstance(WebReportExecutionSettings settings)
Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.
abstract WebReportInstance getNewInstanceEx(String reportID, String extParams, int requestTimeout)
Generates a new report instance by executing the report with the given report ID and extendable parameter, and returns the resultant WebReportInstance.
abstract WebReportInstance getNewInstanceFT(String filterID, String templateID)
Generates a new report instance by executing the given filter and template IDs as a report, and returning the resultant WebReportInstance.
abstract String getPromptAnswer()
Returns the prompt answer, if any, which will be used to pre-answer prompts when executing a new report.
abstract RWDrill2ReportSettings getRWDrill2ReportSettings()
abstract int getResultFlags()
Returns the current setting for the result flags, which will be used when submitting a report for execution to the Intelligence Server or getting the results of a report.
abstract WebResultWindow getResultWindow()
Returns a WebResultWindow object, which can be used to set the window of data that an execution or results retrieval will return.
abstract String getStyleID()
Get the DSSID of the style on this report source, if the style was set by ID.
abstract String getStyleName()
Get the name of the style on this report, if the style was set by name.
abstract String getViewSettings()
Returns the current setting of the view settings XML, which will be sent to the Intelligence Server upon executing a report.
abstract WebReportInstance importCube(String url, String msgID, String tableID, String reportID, String documentID, int behaviorFlags)
Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube
abstract WebReportInstance importCube(PostedFile fileInfo, String reportID)
Create a cube on the IServer based on an imported file
abstract WebReportInstance importCube(String url, String reportID, String documentID)
Create a cube on the IServer based on a file at the specified url
abstract WebReportInstance importCube(String url, String reportID, String documentID, int behaviorFlags)
Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags
abstract WebReportInstance importCube(PostedFile fileInfo, String reportID, String documentID)
Create a cube on the IServer based on an imported file
abstract WebReportInstance importCube(String reportID, String documentID, int behaviorFlags, String data)
Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags
abstract WebReportInstance importCube(PostedFile fileInfo, String msgID, String tableID, String reportID, String documentID, String numOfChunks, String chunkSize, String index, int behaviorFlags)
Create a cube on the IServer based on an imported file, with support to EMMA source table ID.
abstract WebReportInstance importCube(String url, String reportID)
Create a cube on the IServer based on a file at the specified url
abstract WebReportInstance importCube(PostedFile fileInfo, String reportID, String documentID, int behaviorFlags)
Create a cube on the IServer based on an imported file, with support to idc import behavior change flags
abstract WebReportInstance importCube(PostedFile fileInfo, String msgID, String tableID, String reportID, String documentID, int behaviorFlags)
Create a cube on the IServer based on an imported file, with support to EMMA source table ID
abstract WebReportInstance importCube(String msgID, String tableID, String reportID, String documentID, String numOfChunks, String chunkSize, String index, long fileSize, String fileName, String fileType, int behaviorFlags)
Create a cube on the IServer based on an imported file, with support to EMMA source table ID.
abstract WebReportInstance importCube(String msgID, String tableID, String reportID, String documentID, int behaviorFlags, String data)
Create a cube on the IServer based on an imported file, with support to EMMA source table ID
abstract WebReportExecutionSettings newExecutionSettings()
abstract WebReportInstance refresh(String messageID, int stateID, boolean reprompt)
Refresh the report instance specified by the message id and state id.
abstract WebReportInstance refresh(String messageID, int stateID)
Refresh the report instance specified by the message id and state id.
abstract WebReportInstance refresh(String messageID)
Refresh the report instance specified by the message id and latest state.
abstract WebReportInstance refresh(String messageID, boolean reprompt)
Refresh the report instance specified by the message id and latest state.
abstract String setCubeMapping(String msgID, String mappingXML, String cubeRepublishBehavior)
Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
abstract String setCubeMapping(String msgID, String mappingXML, String cubeRepublishBehavior, String documentID)
Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag
abstract String setCubeMapping(String msgID, String mappingXML)
Set the row/column to attribute/metric mapping for the specified imported cube
abstract void setExecutionFlags(int executionFlags)
Sets the execution flags, which will be used when submitting a report for execution to the Intelligence Server.
abstract void setLastExecutionMode(int execMode)
abstract void setPromptAnswer(String promptAnswer)
Sets a prompt answer which will be used to pre-answer any reports executed by this object.
abstract void setResultFlags(int resultFlags)
Sets the result flags, which will be used when submitting a report for execution to the Intelligence Server.
abstract void setStyleID(String styleID)
Set a style by style DSSID.
abstract void setStyleName(String styleName)
Set a style by style name.
abstract void setViewSettings(String viewSettings)
Sets the view settings XML, which will be sent to the Intelligence Server upon executing a report.

Public Methods

public abstract WebReportInstance changeImportedCube (int sheetIndex, String colHeaders, String reportID, String msgID, boolean isUrl, String transformations)

Change the sheet index or insert new column headers on a imported cube@return

Throws
WebObjectsException

public abstract WebReportInstance changeImportedCube (int sheetIndex, String colHeaders, String reportID, String msgID, boolean isUrl, String transformations, String dbRoleID, String sourceAccountID, int behaviorFlags)

Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags@return

Throws
WebObjectsException

public abstract WebReportInstance changeImportedCube (int sheetIndex, String colHeaders, String reportID, String msgID, boolean isUrl, String transformations, String dbRoleID, String sourceAccountID, int behaviorFlags, String documentID)

Change the sheet index or insert new column headers on a imported cube, with support to cubes imported from OAuth source, and support idc behavior change flags@return

Throws
WebObjectsException

public abstract String getBinaryFileContent (PostedFile fileInfo, int maxNumElements, boolean preserveWhiteSpace, String outputDelimiter)

get the contents from binary file

Parameters
fileInfo The PostedFile that represents the file.
maxNumElements the maximum number of elements to return
preserveWhiteSpace indicates if to strip off element’s leading and trailing space
outputDelimiter output delimiter
Returns
  • String formatted data from binary file
Throws
WebObjectsException

public abstract String getDIProjectSettings (int settingID)

get the Data import related project settings.

Returns
  • String containing the value for the setting id.
Throws
WebObjectsException

public abstract WebElementSource getElementSource (String messageID)

Returns a WebElementSource object which can be used to get elements within the working set of the given report.

Parameters
messageID The message ID of the report instance of the working set that the elements will come from.
Returns
  • A WebElementSource object set to return elements within the given report's working set.

public abstract int getExecutionFlags ()

Returns the current setting for the execution flags, which will be used when submitting a report for execution to the Intelligence Server.

Returns
See Also

public abstract WebReportExportSettings getExportSettings (int executionMode)

Returns WebReportExportSettings which can be used to define the type of export and the various parameters for the export

Parameters
executionMode a value from EnumWebReportExecutionModes
Returns

public abstract WebGraphProperties getGraphProperties ()

Return a WebGraphProperties object, which can be used to set the web graph properties. These properties will be passed as a parameter when a report is executed. First time call of this method will return a WebGraphProperties object with no property inside it. User can use the methods exposed by WebGraphProperties interface to add and manipulate the properties inside it. The other calls will return the current setting.

Returns

public abstract WebReportInstance getInstance (String messageID)

Returns a WebReportInstance representing the report execution with the given message ID. Note that this does not cause a report execution to begin, but rather can be used to obtain the results of an already existing report instance.

Parameters
messageID The message ID of the job submitted to the Intelligence Server.
Returns
Throws
WebObjectsException Thrown if the operation cannot be completed successfully.

public abstract WebReportInstance getInstance (String messageID, int stateID)

Returns a WebReportInstance representing the report execution with the given message ID and state ID. Note that this does not cause a report execution to begin, but rather can be used to obtain the results of an already existing report instance.

Parameters
messageID The message ID of the job submitted to the Intelligence Server.
stateID The state ID of the job submitted to the iIntelligence Server.
Returns
Throws
WebObjectsException Thrown if the operation cannot be completed successfully.

public abstract WebReportInstance getInstanceFromRWDrill (RWDrill2ReportSettings drillSettings)

Create a report instance based on the drill from a document.

Parameters
drillSettings RWDrill2ReportSettings The drill parameters object.
Returns
  • WebReportInstance A report instance built after the drill action.
Throws
WebObjectsException
WebObjectsException Thrown when error ocurrs during creating the report instance

public abstract WebReportInstance getInstanceFromSchedule (WebSchedule schedule)

This method is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use getInstanceFromSubscription(WebSubscription) instead.

Create a report instance based on the schedule object. Thus, a report instance with the state similar to a scheduled report can be obtained using this method.

Parameters
schedule The schedule object.
Returns
  • WebReportInstance A report instance built using the schedule information.
Throws
WebObjectsException Thrown when error ocurrs during creating the report instance

public abstract WebReportInstance getInstanceFromState (SAXSupport parser, String uri, String local, String qName, Attributes attrs)

Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().

Parameters
parser SAX parser.
uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
local The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName The qualified name (with prefix), or the empty string if qualified names are not available. attrs The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object
Returns
  • WebReportInstance A report instance restored to state specified by the input parameter.
Throws
WebObjectsException Thrown when error ocurrs during create the report instance according to the input.

public abstract WebReportInstance getInstanceFromState (String savedStateStr)

Create a report instance based on the pre-stored report state, which can be obtained by calling WebReportInstance.saveState().

Parameters
savedStateStr The saved state of a report instance, which is obtained by calling WebReportInstance.saveState().
Returns
  • WebReportInstance A report instance restored to state specified by the input parameter.
Throws
WebObjectsException Thrown when error ocurrs during create the report instance according to the input string.

public abstract WebReportInstance getInstanceFromSubscription (WebSubscription subscription)

Create a report instance based on the subscription object. Thus, a report instance with the state similar to a subscribed report can be obtained using this method.

Parameters
subscription The subscription object.
Returns
  • WebReportInstance A report instance built using the subscription information.
Throws
WebObjectsException Thrown when error ocurrs during creating the report instance

public abstract WebReportInstance getNewInstance (String reportID)

Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.

Parameters
reportID The DSSID of the report to execute.
Returns
Throws
WebObjectsException Signals an error when executing the report.

public abstract WebReportInstance getNewInstance ()

Generates a report instance by executing what is considered to be the "new report" report in metadata.

Returns
Throws
WebObjectsException Signals an error when executing the report.

public abstract WebReportInstance getNewInstance (WebReportExecutionSettings settings)

Generates a new report instance by executing the report with the given report ID, and returns the resultant WebReportInstance.

Parameters
settings The WebReportExecutionSettings
Returns
Throws
WebObjectsException Signals an error when executing the report.

public abstract WebReportInstance getNewInstanceEx (String reportID, String extParams, int requestTimeout)

Generates a new report instance by executing the report with the given report ID and extendable parameter, and returns the resultant WebReportInstance.

Parameters
reportID The DSSID of the report to execute.
extParams extendable parameter when executing the report
requestTimeout Request timeout value. It is used to override the default session request timeout value for the saving job. By default it's -1.
Returns
Throws
WebObjectsException Signals an error when executing the report.

public abstract WebReportInstance getNewInstanceFT (String filterID, String templateID)

Generates a new report instance by executing the given filter and template IDs as a report, and returning the resultant WebReportInstance.

Parameters
filterID The filter ID of the report to execute.
templateID The template ID of the report to execute.
Returns
Throws
WebObjectsException Signals an error when executing the report.

public abstract String getPromptAnswer ()

Returns the prompt answer, if any, which will be used to pre-answer prompts when executing a new report.

Returns
  • The current prompt answer which will be used when executing reports.
See Also

public abstract RWDrill2ReportSettings getRWDrill2ReportSettings ()

Returns

public abstract int getResultFlags ()

Returns the current setting for the result flags, which will be used when submitting a report for execution to the Intelligence Server or getting the results of a report.

Returns
See Also

public abstract WebResultWindow getResultWindow ()

Returns a WebResultWindow object, which can be used to set the window of data that an execution or results retrieval will return.

Returns
  • A WebResultWindow object, which can be edited to change the result window of the report.

public abstract String getStyleID ()

Get the DSSID of the style on this report source, if the style was set by ID.

Returns
  • The DSSID of the style on this report source. null will be returned in two cases, when there is no style set for this report source, and when the style was set by Name. At the second case, you should use getStyleName() to check whether there is a style set by name.
See Also

public abstract String getStyleName ()

Get the name of the style on this report, if the style was set by name.

Returns
  • The name of the style on this report source. null will be returned in two cases, when there is no style set for this report source, and when the style was set by ID. At the second case, you should use getStyleID() to check whether there is a style set by ID.
See Also

public abstract String getViewSettings ()

Returns the current setting of the view settings XML, which will be sent to the Intelligence Server upon executing a report.

Returns
  • The current setting of the view settings XML.
Throws
WebObjectsException Thrown when error in generating the current view setting.
See Also

public abstract WebReportInstance importCube (String url, String msgID, String tableID, String reportID, String documentID, int behaviorFlags)

Create a cube on the IServer based on a file at the specified url, with support to msgID and tableID for EMMA cube

Parameters
url String containing location of the file used to create the new cube
msgID EMMA cube msgID
tableID EMMA source table ID
reportID reportID for republish
documentID the document ID (used for mapping)
behaviorFlags idc behavior change flags 'fg'
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (PostedFile fileInfo, String reportID)

Create a cube on the IServer based on an imported file

Parameters
fileInfo PostedFile representing the file to be imported
reportID reportID for republish
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (String url, String reportID, String documentID)

Create a cube on the IServer based on a file at the specified url

Parameters
url String containing location of the file used to create the new cube
reportID reportID for republish
documentID the document ID (used for mapping)
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (String url, String reportID, String documentID, int behaviorFlags)

Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags

Parameters
url String containing location of the file used to create the new cube
reportID reportID for republish
documentID the document ID (used for mapping)
behaviorFlags idc behavior change flags 'fg'
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (PostedFile fileInfo, String reportID, String documentID)

Create a cube on the IServer based on an imported file

Parameters
fileInfo PostedFile representing the file to be imported
reportID reportID for republish
documentID the document ID (used for mapping)
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (String reportID, String documentID, int behaviorFlags, String data)

Create a cube on the IServer based on a file at the specified url, with support to idc import behavior change flags

Parameters
reportID reportID for republish
documentID the document ID (used for mapping)
behaviorFlags idc behavior change flags 'fg'
data String containing contents of file
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (PostedFile fileInfo, String msgID, String tableID, String reportID, String documentID, String numOfChunks, String chunkSize, String index, int behaviorFlags)

Create a cube on the IServer based on an imported file, with support to EMMA source table ID. Import the file by chunks.

Parameters
fileInfo The PostedFile that represents the file.
msgID message ID for EMMA cube
tableID source table ID for EMMA cube
reportID reportID for republish
documentID the document ID (used for mapping)
numOfChunks the total number of chunks the file split into
chunkSize the size of each chunk
index the index of each chunks
behaviorFlags idc behavior change flags 'fg'
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (String url, String reportID)

Create a cube on the IServer based on a file at the specified url

Parameters
url String containing location of the file used to create the new cube
reportID reportID for republish
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (PostedFile fileInfo, String reportID, String documentID, int behaviorFlags)

Create a cube on the IServer based on an imported file, with support to idc import behavior change flags

Parameters
fileInfo PostedFile representing the file to be imported
reportID reportID for republish
documentID the document ID (used for mapping)
behaviorFlags idc behavior change flags 'fg'
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (PostedFile fileInfo, String msgID, String tableID, String reportID, String documentID, int behaviorFlags)

Create a cube on the IServer based on an imported file, with support to EMMA source table ID

Parameters
fileInfo PostedFile representing the file to be imported
msgID message ID for EMMA cube
tableID source table ID for EMMA cube
reportID reportID for republish
documentID the document ID (used for mapping)
behaviorFlags idc behavior change flags 'fg'
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (String msgID, String tableID, String reportID, String documentID, String numOfChunks, String chunkSize, String index, long fileSize, String fileName, String fileType, int behaviorFlags)

Create a cube on the IServer based on an imported file, with support to EMMA source table ID. Import the file by chunks.

Parameters
msgID message ID for EMMA cube
tableID source table ID for EMMA cube
reportID reportID for republish
documentID the document ID (used for mapping)
numOfChunks the total number of chunks the file split into
chunkSize the size of each chunk
index the index of each chunks
fileSize total size of the file
fileName name of the file
fileType type of the file
behaviorFlags idc behavior change flags 'fg'
Returns
Throws
WebObjectsException

public abstract WebReportInstance importCube (String msgID, String tableID, String reportID, String documentID, int behaviorFlags, String data)

Create a cube on the IServer based on an imported file, with support to EMMA source table ID

Parameters
msgID message ID for EMMA cube
tableID source table ID for EMMA cube
reportID reportID for republish
documentID the document ID (used for mapping)
behaviorFlags idc behavior change flags 'fg'
data {@String } representing the contents of the file
Returns
Throws
WebObjectsException

public abstract WebReportExecutionSettings newExecutionSettings ()

Returns

public abstract WebReportInstance refresh (String messageID, int stateID, boolean reprompt)

Refresh the report instance specified by the message id and state id. If there is any prompt in this report, based on the reprompt parameter, this refresh will or will not reopen the answered prompt.

Parameters
messageID The message ID of the report instance to be refreshed.
stateID The state ID of the report instance to be refreshed.
reprompt When there is prompt in this report, if this is true, the refresh will reopen the prompt; if this is false, the refresh will use the original prompt answer.
Returns
Throws
WebObjectsException Thrown when there is any error occurs during refresh process.

public abstract WebReportInstance refresh (String messageID, int stateID)

Refresh the report instance specified by the message id and state id. This refresh will not reopen the answered prompt, if there is any. Dynamic reports (e.g. drilled reports) cannot be refreshed.

Parameters
messageID The message ID of the report instance to be refreshed.
stateID The state ID of the report instance to be refreshed.
Returns
Throws
WebObjectsException Thrown when there is any error occurs during refresh process.

public abstract WebReportInstance refresh (String messageID)

Refresh the report instance specified by the message id and latest state. This refresh will not reopen the answered prompt, if there is any. Dynamic reports (e.g. drilled reports) cannot be refreshed.

Parameters
messageID The message ID of the report instance to be refreshed.
Returns
Throws
WebObjectsException Thrown when there is any error occurs during refresh process.

public abstract WebReportInstance refresh (String messageID, boolean reprompt)

Refresh the report instance specified by the message id and latest state. If there is any prompt in this report, based on the reprompt parameter, this refresh will or will not reopen the answered prompt.

Parameters
messageID The message ID of the report instance to be refreshed.
reprompt When there is prompt in this report, if this is true, the refresh will reopen the prompt; if this is false, the refresh will use the original prompt answer.
Returns
Throws
WebObjectsException Thrown when there is any error occurs during refresh process.

public abstract String setCubeMapping (String msgID, String mappingXML, String cubeRepublishBehavior)

Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag

Parameters
msgID String containing the message id of the cube to be modified
mappingXML String containing the XML that IServer will use to modify the mapping
cubeRepublishBehavior String containing the cube republishing behavior flag
Returns
  • String containing the message id of the modified report
Throws
WebObjectsException

public abstract String setCubeMapping (String msgID, String mappingXML, String cubeRepublishBehavior, String documentID)

Set the row/column to attribute/metric mapping for the specified imported cube, with support to cube republishing behavior flag

Parameters
msgID String containing the message id of the cube to be modified
mappingXML String containing the XML that IServer will use to modify the mapping
cubeRepublishBehavior String containing the cube republishing behavior flag
documentID String containing the ID of the document for Cube Join
Returns
  • String containing the message id of the modified report
Throws
WebObjectsException

public abstract String setCubeMapping (String msgID, String mappingXML)

Set the row/column to attribute/metric mapping for the specified imported cube

Parameters
msgID String containing the message id of the cube to be modified
mappingXML String containing the XML that IServer will use to modify the mapping
Returns
  • String containing the message id of the modified report
Throws
WebObjectsException

public abstract void setExecutionFlags (int executionFlags)

Sets the execution flags, which will be used when submitting a report for execution to the Intelligence Server.

Parameters
executionFlags The execution flags setting to use. This should be the bitwise or of values from EnumDSSXMLExecutionFlags.
See Also

public abstract void setLastExecutionMode (int execMode)

public abstract void setPromptAnswer (String promptAnswer)

Sets a prompt answer which will be used to pre-answer any reports executed by this object.

Parameters
promptAnswer The value to pre-answer prompts with when executing reports via getNewInstance() or getNewInstanceFT().
See Also

public abstract void setResultFlags (int resultFlags)

Sets the result flags, which will be used when submitting a report for execution to the Intelligence Server.

Parameters
resultFlags The result flags setting to use. This should be the bitwise or of values from EnumDSSXMLResultFlags.
See Also

public abstract void setStyleID (String styleID)

Set a style by style DSSID.

Parameters
styleID the DSSID of the style object to be applied.
See Also

public abstract void setStyleName (String styleName)

Set a style by style name.

Parameters
styleName the name of the style object to be applied.
See Also

public abstract void setViewSettings (String viewSettings)

Sets the view settings XML, which will be sent to the Intelligence Server upon executing a report.

Parameters
viewSettings The new value of the view settings XML.
Throws
WebObjectsException Thrown when the format of the input string is wrong.
See Also