public interface

WebResultSetInstance

implements Persistable
com.microstrategy.web.objects.WebResultSetInstance
Known Indirect Subclasses

Class Overview

Base interface containing method applicable to both document and report instances

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void CancelReprompt()
Cancels reprompt for this instance.
abstract WebSchedule createNewSchedule(WebScheduleTrigger trigger)
This method is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use createNewSubscription(int) instead.
abstract WebSubscription createNewSubscription(int deliveryMode)
Creates a new subscription for this report instance.
abstract String getCacheID()
Returns the ID of the Intelligence Server cache for this result set.
abstract String getCacheLastUpdate()
Returns the date and time when an Intelligence Server cache was last updated.
abstract int getCacheType()
Returns the type of the Intelligence Server cache.
abstract String getIconPath()
Retrieve the iconPath property for the resultSetDefinition object
abstract 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.
abstract String getMessageID()
Returns the message ID associated with this report instance.
abstract int getPollingFrequency()
Returns the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.
abstract WebPrompts getPrompts(String xml)
Builds the collection of prompts associated with the document based on the provided XML and document data.
abstract WebPrompts getPrompts()
Returns the collection of prompts associated with the document or null if the document has no prompts.
abstract int getStateID()
Returns the current state ID set on the report instance.
abstract int getStatus()
Returns the status of the last time the status was checked.
abstract WebViewMediaSettings getViewMediaSettings()
abstract boolean isAsync()
Returns true if the mode is asynchronous when getting results from the Intelligence Server.
abstract 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.
abstract boolean isPromptStatus(int statusValue)
abstract boolean isPromptStatus()
abstract boolean isPrompted()
Returns whether the document is prompted or not.
abstract boolean isReprompted()
Returns a boolean value indicating whether the current WebResultSetInstance is in reprompt status.
abstract boolean isResolved()
abstract boolean isResultOrPromptStatus(int statusValue)
abstract boolean isResultStatus()
abstract boolean isResultStatus(int statusValue)
abstract int pollStatus()
This method will poll the Intelligence Server for the report status.
abstract int pollStatusOnly()
Checks the status (see EnumDSSXMLStatus) of the instance.
abstract void schedule(WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite, boolean isMobile)
abstract void schedule(WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite)
This method is deprecated. use createNewSchedule(WebScheduleTrigger) instead
abstract void setAsync(boolean async)
Sets whether the report instance will obtain results from the Intelligence Server in synchronous or asynchronous mode.
abstract void setIconPath(String iconPath)
Specify the iconPath property for the resultSetDefinition object
abstract 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.
abstract void setPollingFrequency(int millis)
Sets the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable

Public Methods

public abstract void CancelReprompt ()

Cancels reprompt for this instance.

Throws
WebObjectsException thrown if there is any error.

public abstract WebSchedule createNewSchedule (WebScheduleTrigger trigger)

This method is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Please use createNewSubscription(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
WebObjectsException

public abstract WebSubscription createNewSubscription (int deliveryMode)

Creates a new subscription for this report instance.

Parameters
deliveryMode EnumWebSubscriptionDeliveryMode
Returns
  • the new subscription
Throws
WebObjectsException
WebObjectsException

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

Returns
  • The ID of the cache used to fulfill this report or document.

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

Returns
  • The date and time that an Intelligence Server cache was last updated.

public abstract int getCacheType ()

Returns the type of the Intelligence Server cache. For reports or documents which are not cached, this method returns 0. Otherwise, it returns a value from EnumDSSXMLCacheType.

Returns
  • The type of the Intelligence Server cache.

public abstract String getIconPath ()

Retrieve the iconPath property for the resultSetDefinition object

Returns
  • String containing the icon path for the definition object

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

public abstract String getMessageID ()

Returns the message ID associated with this report instance.

Returns
  • The message ID of the report instance.

public abstract int getPollingFrequency ()

Returns the polling frequency, in milliseconds, which will be used when retrieving report results synchronously.

Returns
  • The current polling frequency, in milliseconds.

public abstract WebPrompts getPrompts (String xml)

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.

public abstract WebPrompts getPrompts ()

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.

public abstract int getStateID ()

Returns the current state ID set on the report instance.

Returns
  • The state ID of the report instance.

public abstract int getStatus ()

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
Throws
WebObjectsException Thrown when there is an error occurred during retrieving status information from Intelligence Server.

public abstract WebViewMediaSettings getViewMediaSettings ()

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

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

public abstract boolean isPromptStatus (int statusValue)

public abstract boolean isPromptStatus ()

public abstract boolean isPrompted ()

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.

public abstract boolean isReprompted ()

Returns a boolean value indicating whether the current WebResultSetInstance is in reprompt status.

Returns
  • true only if the current WebResultSetInstance is in its prompted status and has just been refreshed to reprompt.

public abstract boolean isResolved ()

Returns
  • whether the instance is in a ready state, i.e. if it's prompted, whether prompts have been resolved.

public abstract boolean isResultOrPromptStatus (int statusValue)

public abstract boolean isResultStatus ()

public abstract boolean isResultStatus (int statusValue)

public abstract int pollStatus ()

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
Throws
WebObjectsException Signals an inability to obtain the report status from the Intelligence Server.

public abstract int pollStatusOnly ()

Checks the status (see EnumDSSXMLStatus) of the instance.

Returns

public abstract void schedule (WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite, boolean isMobile)

Throws
IllegalArgumentException
WebObjectsException

public abstract void schedule (WebScheduleTrigger trigger, boolean reuseMessage, boolean overWrite)

This method is deprecated.
use createNewSchedule(WebScheduleTrigger) instead

Creates 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 object WebScheduleTrigger 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.
IllegalArgumentException if the trigger object is invalid (null)

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

public abstract void setIconPath (String iconPath)

Specify the iconPath property for the resultSetDefinition object

Parameters
iconPath String containing the icon path for the definition object

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

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