public interface

RWSource

com.microstrategy.web.objects.rw.RWSource

Class Overview

The RWSource interface allows the user to execute and retrieve document instances, along with giving access to many objects which have a supplemental usage in document execution.

Summary

Public Methods
abstract RWIterateSettings createIterateSettings()
abstract byte[] exportDashboard(String docID)
abstract RWExportSettings getExportSettings(int executionMode)
Returns export setting for specified execution mode
abstract String getImportAsyncDashboardMessageID(InputStream data, long dataLength, String folderID, String dashboardName, String dashboardDescription)
abstract String getImportAsyncDashboardResult(String messageID, String dashboardName, boolean isResume)
abstract RWInstance getInstance(String messageID)
Returns a RWInstance representing the document execution with the given message ID.
abstract RWInstance 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 RWInstance getInstanceFromState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
Create a document instance based on a pre-stored document state.
abstract RWInstance getInstanceFromState(String savedStateStr)
Creates a document instance based on a pre-stored document state.
abstract RWInstance getInstanceFromSubscription(WebSubscription subscription)
Create a document instance based on the subscription object.
abstract RWInstance getInstanceFromSubscription(WebSubscription subscription, int executionMode)
Create a document instance based on the subscription object.
abstract RWInstance getNewInstance(String documentID, int executionMode)
Generates a new document instance by executing the document with the given Document ID.
abstract RWInstance getNewInstance(String documentID)
Generates a new document instance by executing the document with the given Document ID.
abstract RWInstance getNewInstance(int executionMode)
This method is used in conjunction with getReport2RWSettings() for converting reports into report writing documents.
abstract RWInstance getNewInstance(String rwId, int executionMode, String delta, int extraExecFlags)
abstract RWInstance getNewInstance(String documentID, int executionMode, boolean isDossier)
Generates a new document instance by executing the document with the given Document ID.
abstract RWInstance getNewInstance(String documentID, RWSettings rwSettings)
abstract RWInstance getNewInstance(String documentID, boolean isDossier)
Generates a new document instance by executing the document with the given Document ID.
abstract RWInstance getNewInstance(String rwId, int executionMode, String delta, int extraExecFlags, String prevMsgID)
abstract int getPreviousExecutionMode()
Returns the previous execution mode for calls to getInstance that takes a message ID.
abstract String getPromptAnswer()
Returns the prompt answer, if any, which will be used to pre-answer prompts when executing a new document.
abstract RWSettings getRWSettings(int executionMode)
Returns the RWSettings for specified execution mode
abstract Report2RWSettings getReport2RWSettings()
abstract boolean getSaveToInbox()
Retrieves a boolean property indicating that the result of the execution should be saved to the Inbox This setting will take effect only when the execution mode (EnumRWExecutionModes) on the RWInstance is set to RW_MODE_DATA
abstract Theme2RWSettings getTheme2RWSettings()
abstract boolean getUpdateDSCaches()
abstract String importDashboard(InputStream data, long dataLength, String folderID)
abstract boolean isBackgroundDocumentExecution()
Retrieves the value of the property set using {setBackgroundDocumentExecution(boolean)
abstract boolean isFreshDocumentExecution()
Retrives the value of the proprety set using {#setFreshDocumentExecution}
abstract boolean isUseDefaultPromptAnswers()
Retrives the value of the proprety set using {#setUseDefaultPromptAnswers}
abstract void setBackgroundDocumentExecution(boolean background)
Sets a property indicating that the document is executed as a background job.
abstract void setFreshDocumentExecution(boolean value)
Sets a property indicating that the caches should not be used and a fresh document execution should be done.
abstract void setPreviousExecutionMode(int executionMode)
Sets the previous execution mode for calls to getInstance that takes a message ID.
abstract void setPromptAnswer(String promptAnswer)
Sets a prompt answer which will be used to pre-answer any documents executed by this object.
abstract void setSaveToInbox(boolean saveToInbox)
Sets a boolean property indicating that the result of the execution should be saved to the Inbox This setting will take effect only when the execution mode (EnumRWExecutionModes) on the RWInstance is set to RW_MODE_DATA
abstract void setUpdateDSCaches(boolean value)
abstract void setUseDefaultPromptAnswers(boolean useDefault)
Sets a property indicating that the default prompts answers should be used during execution

Public Methods

public abstract RWIterateSettings createIterateSettings ()

Returns

public abstract byte[] exportDashboard (String docID)

public abstract RWExportSettings getExportSettings (int executionMode)

Returns export setting for specified execution mode

Parameters
executionMode execution mode from EnumRWExecutionModes
Returns
  • RWExportSettings

public abstract String getImportAsyncDashboardMessageID (InputStream data, long dataLength, String folderID, String dashboardName, String dashboardDescription)

public abstract String getImportAsyncDashboardResult (String messageID, String dashboardName, boolean isResume)

public abstract RWInstance getInstance (String messageID)

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

Parameters
messageID The message ID of the job submitted to the Intelligence Server.
Returns
  • A RWInstance object, representing the document with the given message ID.
Throws
WebObjectsException Thrown if the operation cannot be completed successfully.

public abstract RWInstance 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 document instance based on the schedule object. Thus, a document instance with the state similar to a scheduled document can be obtained using this method.

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

public abstract RWInstance getInstanceFromState (SAXSupport parser, String uri, String localName, String qName, Attributes attrs)

Create a document instance based on a pre-stored document state. A document instance state can be obtained using the persistence support on RWInstance

Parameters
parser The SAX parser parsing the state (in which the the document state is embedded, if it is not the only state).
uri The uri value of the SAX node from where the current parsing of the document state is invoked.
localName The localName value of the SAX node from where the current parsing of the document state is invoked.
qName The qName value of the SAX node from where the current parsing of the document state is invoked.
attrs The attributes of the SAX node from where the current parsing of the document state is invoked.
Returns
  • RWInstance A document instance restored to state specified by the input parameter.
Throws
WebObjectsException Thrown when an error occurs restoring the document instance state.

public abstract RWInstance getInstanceFromState (String savedStateStr)

Creates a document instance based on a pre-stored document state. A document instance state can be obtained using the persistence support on RWInstance

Parameters
savedStateStr The saved state of a document instance.
Returns
  • RWInstance A document instance restored to state specified by the input parameter.
Throws
WebObjectsException Thrown when an error occurs restoring the document instance state using the the state string.

public abstract RWInstance getInstanceFromSubscription (WebSubscription subscription)

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

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

public abstract RWInstance getInstanceFromSubscription (WebSubscription subscription, int executionMode)

Create a document instance based on the subscription object. Thus, a document instance with the state similar to a subscribed document can be obtained using this method. This method can also change the execution mode of the instance.

Parameters
subscription The subscription object.
executionMode see EnumRWExecutionModes
Returns
  • RWInstance A document instance built using the subscription information.
Throws
WebObjectsException Thrown when error ocurrs during creating the document instance

public abstract RWInstance getNewInstance (String documentID, int executionMode)

Generates a new document instance by executing the document with the given Document ID.

Parameters
documentID The DSSID of the document to execute.
executionMode specifies a value from EnumRWExecutionModes
Returns
  • A RWInstance object, representing the document executed by this method.
Throws
WebObjectsException Signals an error encountered by IServer when executing the document.

public abstract RWInstance getNewInstance (String documentID)

Generates a new document instance by executing the document with the given Document ID.

Parameters
documentID The DSSID of the document to execute.
Returns
  • A RWInstance object, representing the document executed by this method.
Throws
WebObjectsException Signals an error encountered by IServer when executing the document.

public abstract RWInstance getNewInstance (int executionMode)

This method is used in conjunction with getReport2RWSettings() for converting reports into report writing documents.

Parameters
executionMode see EnumRWExecutionModes
Returns
  • a new RWInstance
Throws
WebObjectsException if an error occurs during the conversion

public abstract RWInstance getNewInstance (String rwId, int executionMode, String delta, int extraExecFlags)

public abstract RWInstance getNewInstance (String documentID, int executionMode, boolean isDossier)

Generates a new document instance by executing the document with the given Document ID.

Parameters
documentID The DSSID of the document to execute.
executionMode specifies a value from EnumRWExecutionModes
Returns
  • A RWInstance object, representing the document executed by this method.
Throws
WebObjectsException Signals an error encountered by IServer when executing the document.

public abstract RWInstance getNewInstance (String documentID, RWSettings rwSettings)

Parameters
documentID The DSSID of the document to execute.
rwSettings the RWSettings object we use to obtain the new instance
Returns
  • A RWInstance object, representing the document executed by this method.

public abstract RWInstance getNewInstance (String documentID, boolean isDossier)

Generates a new document instance by executing the document with the given Document ID.

Parameters
documentID The DSSID of the document to execute.
Returns
  • A RWInstance object, representing the document executed by this method.
Throws
WebObjectsException Signals an error encountered by IServer when executing the document.

public abstract RWInstance getNewInstance (String rwId, int executionMode, String delta, int extraExecFlags, String prevMsgID)

public abstract int getPreviousExecutionMode ()

Returns the previous execution mode for calls to getInstance that takes a message ID. This will be assumed to be the current execution mode of the report at instance creation time. The default value is -1, which means the previous mode is unknown and should be determined via the API.

Returns
  • The previous execution mode.

public abstract String getPromptAnswer ()

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

Returns
  • The current prompt answer which will be used when executing documents.

public abstract RWSettings getRWSettings (int executionMode)

Returns the RWSettings for specified execution mode

Parameters
executionMode execution mode from EnumRWExecutionModes
Returns

public abstract Report2RWSettings getReport2RWSettings ()

Returns
  • settings governing conversion of a report into a report writing document

public abstract boolean getSaveToInbox ()

Retrieves a boolean property indicating that the result of the execution should be saved to the Inbox This setting will take effect only when the execution mode (EnumRWExecutionModes) on the RWInstance is set to RW_MODE_DATA

public abstract Theme2RWSettings getTheme2RWSettings ()

Returns
  • settings governing conversion of a theme into a report writing document

public abstract boolean getUpdateDSCaches ()

public abstract String importDashboard (InputStream data, long dataLength, String folderID)

public abstract boolean isBackgroundDocumentExecution ()

Retrieves the value of the property set using {setBackgroundDocumentExecution(boolean)

Returns

public abstract boolean isFreshDocumentExecution ()

Retrives the value of the proprety set using {#setFreshDocumentExecution}

Returns
  • the value of the proprety set using {#setFreshDocumentExecution}

public abstract boolean isUseDefaultPromptAnswers ()

Retrives the value of the proprety set using {#setUseDefaultPromptAnswers}

Returns
  • the value of the proprety set using {#setUseDefaultPromptAnswers}

public abstract void setBackgroundDocumentExecution (boolean background)

Sets a property indicating that the document is executed as a background job.

public abstract void setFreshDocumentExecution (boolean value)

Sets a property indicating that the caches should not be used and a fresh document execution should be done.

public abstract void setPreviousExecutionMode (int executionMode)

Sets the previous execution mode for calls to getInstance that takes a message ID. This will be assumed to be the current execution mode of the report at instance creation time. The default value is -1, which means the previous mode is unknown and should be determined by the API.

Parameters
executionMode The previous execution mode.

public abstract void setPromptAnswer (String promptAnswer)

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

Parameters
promptAnswer The value to pre-answer prompts with when executing documents.

public abstract void setSaveToInbox (boolean saveToInbox)

Sets a boolean property indicating that the result of the execution should be saved to the Inbox This setting will take effect only when the execution mode (EnumRWExecutionModes) on the RWInstance is set to RW_MODE_DATA

public abstract void setUpdateDSCaches (boolean value)

public abstract void setUseDefaultPromptAnswers (boolean useDefault)

Sets a property indicating that the default prompts answers should be used during execution