Package com.microstrategy.web.beans

Interface ResultSetBean

    • Method Detail

      • getMessageID

        java.lang.String getMessageID()
                       throws WebBeanException
        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.

      • setMessageID

        void setMessageID​(java.lang.String msgID)
        Sets the message ID to the result set instance contained in this ResultSetBean.
        Parameters:
        msgID - the message ID set on this ResultSetBean.

      • getLastPromptMessageID

        java.lang.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.
        Since:
        MicroStrategy Web 9.0.0

      • getStateID

        int getStateID()
        throws WebBeanException
        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.

      • setStateID

        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

      • getMaxWait

        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.

      • setMaxWait

        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.

      • getPollingFrequency

        int getPollingFrequency()
        Returns the polling frequency, in milliseconds, which will be used when retrieving the results synchronously.
        Returns:
        The current frequency, in milliseconds.

      • setPollingFrequency

        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.

      • isPrompted

        boolean isPrompted()
            throws WebBeanException
        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.

      • getSaveToInbox

        boolean getSaveToInbox()
        Returns the flag indicating whether to save the result into user's Inbox.
        Returns:
        true if saving the result into Inbox

      • setSaveToInbox

        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

      • getExpiration

        int getExpiration()
        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.

      • setExpiration

        void setExpiration​(int hoursExpire)
        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.

      • getPromptsBean

        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.

      • setPromptsEventHandler

        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.

      • getPromptsEventHandler

        WebEventHandler getPromptsEventHandler()
        Returns the prompts event handler associated with the PromptsBean.
        Returns:
        the prompts event handler
        See Also:
        getPromptsBean()

      • cancelRequest

        boolean cancelRequest()
        Cancels the current request.
        Returns:
        returns true if successfully canceled.

      • refresh

        void refresh​(boolean rePrompt)
      throws WebBeanException
        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.

      • initializeFromSchedule

        void initializeFromSchedule​(WebSchedule s)
                     throws WebBeanException
        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.

      • initializeFromSubscription

        void initializeFromSubscription​(WebSubscription s)
                         throws WebBeanException
        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.

      • setDisplayName

        void setDisplayName​(java.lang.String displayName)
             throws WebBeanException
        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
        Since:
        MicroStrategy Web 9.0.0

      • isReady

        boolean isReady()
         throws WebBeanException,
                WebObjectsException
        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.