public interface

ResultSetBean

implements ObjectBean
com.microstrategy.web.beans.ResultSetBean
Known Indirect Subclasses

Class Overview

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract boolean cancelRequest()
Cancels the current request.
abstract int getExpiration()
This method is deprecated. As of WU 8.0.
abstract String getLastPromptMessageID()
Whenever refresh(boolean) with the reprompt argument set to true, a duplicate message is made in order to answer all the new prompts, i.e.
abstract int getMaxWait()
Returns the maximum amount of time, in milliseconds.
abstract String getMessageID()
Returns the message ID associated with the result set instance contained in this ResultSetBean.
abstract int getPollingFrequency()
Returns the polling frequency, in milliseconds, which will be used when retrieving the results synchronously.
abstract PromptsBean getPromptsBean()
Returns the embedded PromptsBean.
abstract WebEventHandler getPromptsEventHandler()
Returns the prompts event handler associated with the PromptsBean.
abstract WebResultSetInstance getResultSetInstance()
Returns the result set instance.
abstract boolean getSaveToInbox()
Returns the flag indicating whether to save the result into user's Inbox.
abstract int getStateID()
Returns the current state ID set on the result set instance ResultSetBean.
abstract void initializeFromSchedule(WebSchedule s)
This method is deprecated. Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use initializeFromSubscription(WebSubscription) instead.
abstract void initializeFromSubscription(WebSubscription s)
Initializes the bean using a WebSubscription object.
abstract boolean isPrompted()
Returns a boolean value indicating whether the result set instance contains any prompt questions.
abstract boolean isReady()
Indicates whether the result set is in a "ready" state where results can be retrieved.
abstract void refresh(boolean rePrompt)
Refreshes the underlying objects encapsulated by this bean with the option to reopen the prompt.
abstract void refresh()
Refreshes the underlying WebResultSetInstance.
abstract void setDisplayName(String displayName)
Set display name of the bean.
abstract void setExpiration(int hoursExpire)
This method is deprecated. As of WU 8.0.
abstract void setMaxWait(int millis)
Sets the maximum amount of time, in milliseconds.
abstract void setMessageID(String msgID)
Sets the message ID to the result set instance contained in this ResultSetBean.
abstract void setPollingFrequency(int millis)
Sets the polling frequency, in milliseconds, which will be used when retrieving the results synchronously.
abstract void setPromptsEventHandler(WebEventHandler promptsEventHandler)
Sets the prompt event handler on this bean, which the ResultSetBean applies to the embedded PromptsBean.
abstract void setSaveToInbox(boolean saveToInbox)
Sets the boolean value indicating whether to save the result into user's Inbox.
abstract void setStateID(int stateID)
Sets a state ID on the result set instance contained in this ResultSetBean.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.ObjectBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract boolean cancelRequest ()

Cancels the current request.

Returns
  • returns true if successfully canceled.

public abstract int getExpiration ()

This method is deprecated.
As of WU 8.0.

Returns the amount of time, in hours, to expire the cached execution results on this ResultSetBean of 0 means the results are immediately expired.

Returns
  • the expiration time, in hours, of the results cached in this ResultSetBean.

public abstract String getLastPromptMessageID ()

Whenever refresh(boolean) with the reprompt argument set to true, a duplicate message is made in order to answer all the new prompts, i.e. getMessageID() will return the new message ID of the duplicate. This method will return the original message ID prior to the reprompt.

Returns
  • the last message ID before the current prompt.

public abstract int getMaxWait ()

Returns the maximum amount of time, in milliseconds. ResultSetBean will wait for the execution result in synchronous mode. This can be used to provide an upper bound on synchronous execution time. The value of 0 means to run the result set will execute in asynchronous mode, while -1 means waiting indefinitely until the data is returned or error occurs.

Returns
  • the current setting for the maxWait property.

public abstract String getMessageID ()

Returns the message ID associated with the result set instance contained in this ResultSetBean.

Returns
  • the message ID of the result set instance.
Throws
WebBeanException thrown if error occurred when retrieving the message ID.

public abstract int getPollingFrequency ()

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

Returns
  • The current frequency, in milliseconds.

public abstract PromptsBean getPromptsBean ()

Returns the embedded PromptsBean. If this ResultSetBean does not contains any prompt questions, the returned PromptsBean will not contain a PromptObject. If the ResultSetBean represents a document, then all prompts in all reports within the document will be contained in the bean.

Returns
  • the embedded PromptsBean.

public abstract WebEventHandler getPromptsEventHandler ()

Returns the prompts event handler associated with the PromptsBean.

Returns
  • the prompts event handler
See Also

public abstract WebResultSetInstance getResultSetInstance ()

Returns the result set instance.

Returns
  • the result set instance.

public abstract boolean getSaveToInbox ()

Returns the flag indicating whether to save the result into user's Inbox.

Returns
  • true if saving the result into Inbox

public abstract int getStateID ()

Returns the current state ID set on the result set instance ResultSetBean.

Returns
  • the state ID set on the result set instance
Throws
WebBeanException thrown if error occurred when retrieving the state ID.

public abstract void initializeFromSchedule (WebSchedule s)

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

Initializes the bean using a WebSchedule object. Thus the bean is setup to a state similar to the scheduled publication.

Parameters
s the schedule.
Throws
WebBeanException thrown if any error occurs during setting up the bean using the schedule passed.

public abstract void initializeFromSubscription (WebSubscription s)

Initializes the bean using a WebSubscription object. Thus the bean is setup to a state similar to the subscribed publication.

Parameters
s the subscription instance.
Throws
WebBeanException thrown if any error occurs during setting up the bean using the subscription passed.

public abstract boolean isPrompted ()

Returns a boolean value indicating whether the result set instance contains any prompt questions.

Returns
  • true if the result set instance contains prompts
Throws
WebBeanException thrown if error occurred when retrieving the prompted information.

public abstract boolean isReady ()

Indicates whether the result set is in a "ready" state where results can be retrieved.

Returns
  • True if the data for the result set can be retrieved now; otherwise, false.
Throws
WebBeanException If we are unable to retrieve the result set instance from the bean.
WebObjectsException If we are unable to get the status of the result set instance from the Intelligence Server.

public abstract void refresh (boolean rePrompt)

Refreshes the underlying objects encapsulated by this bean with the option to reopen the prompt.

Parameters
rePrompt true if you want to re-open the answered prompt if there is any.
Throws
WebBeanException thrown if any error occurs during refreshing.

public abstract void refresh ()

Refreshes the underlying WebResultSetInstance. This refresh will not reopen the answered prompt, if any.

Throws
WebBeanException thrown if error occurs when refreshing.

public abstract void setDisplayName (String displayName)

Set display name of the bean. By default it is doing nothing. For report bean it will update the display name of its underlying WebMessage by calling com.microstrategy.web.objects.WebDisplayUnit#setDisplayName() as soon as the prompt is answered, but do not have to wait for the report being executed.

Throws
WebBeanException
WebBeanException

public abstract void setExpiration (int hoursExpire)

This method is deprecated.
As of WU 8.0.

Returns the amount of time, in hours, to expire the cached execution results on this ResultSetBean. If a value of 0 is supplied, the results are immediately expired.

Parameters
hoursExpire expiration time in hours.

public abstract void setMaxWait (int millis)

Sets the maximum amount of time, in milliseconds. ResultSetBean will wait for the execution results synchronous mode. This can be used to provide an upper bound on synchronous execution time. The value of 0 means to run the result set in asynchronous mode, while -1 means waiting indefinitely until the data is returned or error occurs.

Parameters
millis the maximum amount of time to wait in synchronous mode.

public abstract void setMessageID (String msgID)

Sets the message ID to the result set instance contained in this ResultSetBean.

Parameters
msgID the message ID set on this ResultSetBean.

public abstract void setPollingFrequency (int millis)

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

Parameters
millis the polling frequency to use, in milliseconds.

public abstract void setPromptsEventHandler (WebEventHandler promptsEventHandler)

Sets the prompt event handler on this bean, which the ResultSetBean applies to the embedded PromptsBean. If any prompt events are sent to the ResultSetBean event handler, it may delegate it to the PromptsBean event handler.

Parameters
promptsEventHandler a prompts event handler instance.

public abstract void setSaveToInbox (boolean saveToInbox)

Sets the boolean value indicating whether to save the result into user's Inbox.

Parameters
saveToInbox true if want to save the result set to Inbox

public abstract void setStateID (int stateID)

Sets a state ID on the result set instance contained in this ResultSetBean.

Parameters
stateID the state ID set on the result set instance