Package com.microstrategy.web.objects
Interface WebResultSetInstance
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
- All Known Subinterfaces:
RWInstance
,WebDocumentInstance
,WebReportInstance
public interface WebResultSetInstance extends Persistable
Base interface containing method applicable to both document and report instances- Since:
- MicroStrategy Web 7.5.1
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
CancelReprompt()
Cancels reprompt for this instance.WebSchedule
createNewSchedule(WebScheduleTrigger trigger)
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.WebSubscription
createNewSubscription(int deliveryMode)
Creates a new subscription for this report instance.java.lang.String
getCacheID()
Returns the ID of the Intelligence Server cache for this result set.java.lang.String
getCacheLastUpdate()
Returns the date and time when an Intelligence Server cache was last updated.int
getCacheType()
Returns the type of the Intelligence Server cache.java.lang.String
getIconPath()
Retrieve the iconPath property for the resultSetDefinition objectboolean
getIsPVPartialExecution()
int
getMaxWait()
Returns the maximum amount of time, in milliseconds, the API will wait for a report result from the server when retrieving results in synchronous mode.java.lang.String
getMessageID()
Returns the message ID associated with this report instance.int
getPollingFrequency()
Returns the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.WebPrompts
getPrompts()
Returns the collection of prompts associated with the document or null if the document has no prompts.WebPrompts
getPrompts(java.lang.String xml)
Builds the collection of prompts associated with the document based on the provided XML and document data.int
getStateID()
Returns the current state ID set on the report instance.int
getStatus()
Returns the status of the last time the status was checked.WebViewMediaSettings
getViewMediaSettings()
boolean
isAsync()
Returns true if the mode is asynchronous when getting results from the Intelligence Server.boolean
isModified()
Return a boolean indicating whether this instance has been modified and there are changes in memory that have not been sent to the Intelligence server for processing.boolean
isPrompted()
Returns whether the document is prompted or not.boolean
isPromptStatus()
boolean
isPromptStatus(int statusValue)
boolean
isReprompted()
Returns a boolean value indicating whether the currentWebResultSetInstance
is in reprompt status.boolean
isResolved()
boolean
isResultOrPromptStatus(int statusValue)
boolean
isResultStatus()
boolean
isResultStatus(int statusValue)
int
pollStatus()
This method will poll the Intelligence Server for the report status.int
pollStatusOnly()
Checks the status (seeEnumDSSXMLStatus
) of the instance.void
schedule(WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite)
Deprecated.usecreateNewSchedule(WebScheduleTrigger)
insteadvoid
schedule(WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite, boolean isMobile)
void
setAsync(boolean async)
Sets whether the report instance will obtain results from the Intelligence Server in synchronous or asynchronous mode.void
setIconPath(java.lang.String iconPath)
Specify the iconPath property for the resultSetDefinition objectvoid
setIsPVPartialExecution(boolean isPartialExec)
//US72098 Indicates if the rw instance was created with a partial execution of the delta xmlvoid
setMaxWait(int millis)
Sets the maximum amount of time, in milliseconds, the API will wait for a report result from the server when retrieving results in synchronous mode.void
setPollingFrequency(int millis)
Sets the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
-
-
-
Method Detail
-
getMessageID
java.lang.String getMessageID()
Returns the message ID associated with this report instance.- Returns:
- The message ID of the report instance.
- Since:
- MicroStrategy Web 8.0.0
-
getStateID
int getStateID()
Returns the current state ID set on the report instance.- Returns:
- The state ID of the report instance.
- Since:
- MicroStrategy Web 8.0.0
-
getStatus
int getStatus() throws WebObjectsException
Returns the status of the last time the status was checked. If the status has been checked before, this method does not cause the status to be checked - it just returns the status of the last time when a method checked the status. If the status has not been checked before, it will asynchronously call Intelligence Server once to get a valid status.- Returns:
- the current status, from
EnumDSSXMLStatus
. - Throws:
WebObjectsException
- Thrown when there is an error occurred during retrieving status information from Intelligence Server.- Since:
- MicroStrategy Web 8.0.0
-
isAsync
boolean isAsync()
Returns true if the mode is asynchronous when getting results from the Intelligence Server. Asynchronous mode will simply check the status of an executing report once, and return, regardless of whether it is complete executing or not.- Returns:
- Whether this object will retrieve results from the Intelligence Server in asynchronous mode.
- Since:
- MicroStrategy Web 8.0.0
-
setAsync
void setAsync(boolean async)
Sets whether the report instance will obtain results from the Intelligence Server in synchronous or asynchronous mode.- Parameters:
async
- Whether results will be retrieved in asynchronous mode.- Since:
- MicroStrategy Web 8.0.0
-
getMaxWait
int getMaxWait()
Returns the maximum amount of time, in milliseconds, the API will wait for a report result from the server when retrieving results in synchronous mode. This can be used to provide an upper bound on synchronous execution time.- Returns:
- The current setting for the maxWait property.
- Since:
- MicroStrategy Web 8.0.0
- See Also:
setMaxWait(int)
-
setMaxWait
void setMaxWait(int millis)
Sets the maximum amount of time, in milliseconds, the API will wait for a report result from the server when retrieving results in synchronous mode. This can be used to provide an upper bound on synchronous execution time.- Parameters:
millis
- The maximum amount of time, in milliseconds, to wait for a report to finish execution before returning while in synchronous mode.- Since:
- MicroStrategy Web 8.0.0
- See Also:
getMaxWait()
-
getPollingFrequency
int getPollingFrequency()
Returns the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.- Returns:
- The current polling frequency, in milliseconds.
- Since:
- MicroStrategy Web 8.0.0
- See Also:
setPollingFrequency(int)
-
setPollingFrequency
void setPollingFrequency(int millis)
Sets the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.- Parameters:
millis
- The polling frequency to use, in milliseconds.- Since:
- MicroStrategy Web 8.0.0
- See Also:
getPollingFrequency()
-
pollStatus
int pollStatus() throws WebObjectsException
This method will poll the Intelligence Server for the report status. If async = true, then it will poll the server once, and return the status. If async = false, then this method will poll the Intelligence Server until either the max wait time has been exceeded or a final status has been reached.- Returns:
- status of the report upon returning, from
EnumDSSXMLStatus
. - Throws:
WebObjectsException
- Signals an inability to obtain the report status from the Intelligence Server.- Since:
- MicroStrategy Web 8.0.0
-
isPrompted
boolean isPrompted() throws WebObjectsException
Returns whether the document is prompted or not.- Returns:
- boolean value indicating whether the document is prompted.
- Throws:
WebObjectsException
- if the IServer encountered an error or if an unexpected status was encountered while obtaining the required result.- Since:
- MicroStrategy Web 8.0.0
-
isModified
boolean isModified()
Return a boolean indicating whether this instance has been modified and there are changes in memory that have not been sent to the Intelligence server for processing.- Returns:
- whether this instance has been modified
- Since:
- MicroStrategy Web 8.0.0
-
getPrompts
WebPrompts getPrompts() throws WebObjectsException
Returns the collection of prompts associated with the document or null if the document has no prompts.- Returns:
- The collection of prompts associated with the document or null if the document has no prompts.
- Throws:
WebObjectsException
- if there were some problems obtaining prompt XML or if there were some errors in the XML format.- Since:
- MicroStrategy Web 8.0.0
-
getPrompts
WebPrompts getPrompts(java.lang.String xml) throws WebObjectsException
Builds the collection of prompts associated with the document based on the provided XML and document data.- Parameters:
xml
- prompts XML- Returns:
- The collection of prompts associated with the document.
- Throws:
WebObjectsException
- if there were some errors in the XML format.- Since:
- MicroStrategy Web 8.0.0
-
schedule
void schedule(WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite) throws WebObjectsException, java.lang.IllegalArgumentException
Deprecated.usecreateNewSchedule(WebScheduleTrigger)
insteadCreates a schedule for the current state of the report instance. The type of schedule is message schedule. The message ID is reused based on the reuseMessage flag passed. Also, setting overWrite to true implies that if the schedule exists, it will be overwritten.- Parameters:
trigger
- The trigger objectWebScheduleTrigger
for the schedule.reuseMessage
- True to reuse the message ID.overWrite
- True to overwrite a schedule if it already exists.- Throws:
WebObjectsException
- if IServer encountered an error while creating the schedule.java.lang.IllegalArgumentException
- if the trigger object is invalid (null)- Since:
- MicroStrategy Web 8.0.0
-
schedule
void schedule(WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite, boolean isMobile) throws WebObjectsException, java.lang.IllegalArgumentException
- Throws:
WebObjectsException
java.lang.IllegalArgumentException
- Since:
- MicroStrategy Web 8.1.1
-
createNewSchedule
WebSchedule createNewSchedule(WebScheduleTrigger trigger) throws WebObjectsException
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please usecreateNewSubscription(int)
instead.Creates a new schedule for this report instance. The schedule object is initialized from the current instance. It needs to be saved explicitly.- Parameters:
trigger
- schedule triggerWebScheduleTrigger
- Returns:
- the new subscription
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 8.0.1
-
createNewSubscription
WebSubscription createNewSubscription(int deliveryMode) throws WebObjectsException
Creates a new subscription for this report instance.- Parameters:
deliveryMode
-EnumWebSubscriptionDeliveryMode
- Returns:
- the new subscription
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 8.0.0
-
CancelReprompt
void CancelReprompt() throws WebObjectsException
Cancels reprompt for this instance.- Throws:
WebObjectsException
- thrown if there is any error.- Since:
- MicroStrategy Web 8.0.0
-
isReprompted
boolean isReprompted()
Returns a boolean value indicating whether the currentWebResultSetInstance
is in reprompt status.- Returns:
true
only if the currentWebResultSetInstance
is in its prompted status and has just been refreshed to reprompt.- Since:
- MicroStrategy Web 8.0.1
-
isResolved
boolean isResolved() throws WebObjectsException
- Returns:
- whether the instance is in a ready state, i.e. if it's prompted, whether prompts have been resolved.
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getViewMediaSettings
WebViewMediaSettings getViewMediaSettings() throws WebObjectsException
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
getIconPath
java.lang.String getIconPath() throws WebObjectsException
Retrieve the iconPath property for the resultSetDefinition object- Returns:
String
containing the icon path for the definition object- Throws:
WebObjectsException
-
setIconPath
void setIconPath(java.lang.String iconPath) throws WebObjectsException
Specify the iconPath property for the resultSetDefinition object- Parameters:
iconPath
-String
containing the icon path for the definition object- Throws:
WebObjectsException
-
pollStatusOnly
int pollStatusOnly() throws WebObjectsException
Checks the status (seeEnumDSSXMLStatus
) of the instance.- Returns:
- status (see
EnumDSSXMLStatus
) - Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.0
-
isResultStatus
boolean isResultStatus()
-
isResultStatus
boolean isResultStatus(int statusValue)
-
isPromptStatus
boolean isPromptStatus()
-
isPromptStatus
boolean isPromptStatus(int statusValue)
-
isResultOrPromptStatus
boolean isResultOrPromptStatus(int statusValue)
-
getCacheID
java.lang.String getCacheID()
Returns the ID of the Intelligence Server cache for this result set. For reports or documents which are not cached, this method will returnnull
.- Returns:
- The ID of the cache used to fulfill this report or document.
-
getCacheType
int getCacheType()
Returns the type of the Intelligence Server cache. For reports or documents which are not cached, this method returns0
. Otherwise, it returns a value fromEnumDSSXMLCacheType
.- Returns:
- The type of the Intelligence Server cache.
-
getCacheLastUpdate
java.lang.String getCacheLastUpdate()
Returns the date and time when an Intelligence Server cache was last updated. The time returned is adjusted for the caller's locale. If no cache was used for this execution, then this method will returnnull
.- Returns:
- The date and time that an Intelligence Server cache was last updated.
-
setIsPVPartialExecution
void setIsPVPartialExecution(boolean isPartialExec)
//US72098 Indicates if the rw instance was created with a partial execution of the delta xml
-
getIsPVPartialExecution
boolean getIsPVPartialExecution()
-
-