WebDocumentStatement

Class Overview

This interface defines a document statement which is used to identify a server command within a schedule that targets a Document. This object cannot be directly instantiated, and can only be obtained indirectly from the other scheduling-related objects. While Document Schedules are read and populated from IServer using WebScheduleSource a WebDocumentStatement object is automatically created for each Document Schedule. Similarly, if a user wants to create a new Document Schedule on IServer, a WebDocumentStatement object gets created in the process and the user needs to populate the WebDocumentStatement with necessary information/properties like the target document for the schedule which are inherited from WebContentStatement

Summary

[Expand] Inherited Methods
From interface com.microstrategy.web.objects.WebContentStatement abstract int getExecutionFlags() This method returns the current value for the execution flags the Intelligence Server will use abstract String getMessageID() Returns the current inbox message ID being used by this statement, if applicable. abstract WebPrompts getPrompts() Returns the WebPrompts object corresponding to the Report or Document. abstract boolean getReuseMessage() This method returns the current value of the reuseMessage flag, which tells whether to reuse the same inbox message or create a new message each time a report or document is executed. abstract WebObjectInfo getTarget() Returns a WebObjectInfo object, which provides additional information on the report or document object rooted in the statement. abstract boolean hasPromptPersonalization() This method is used to check whether the current schedule has prompts or not. abstract boolean isMobileEnabled() abstract boolean isResolved() If the answers for the prompts of an existing report/document are modified (calling getPrompts()) or if a new schedule to be created corresponds to a prompted report/document, then this method is used to figure out if the Prompts are resolved or not. abstract void reprompt() Reopens the prompts if they have already been answered. abstract void setExecutionFlags(int executionFlags) This method allows the user to specify the execution flags the Intelligence Server will use. abstract void setMobileEnabled(boolean isMobile) abstract void setReuseMessage(boolean reuseMessage) This method specifies the reuseMessage flag, which tells whether to reuse the same inbox message or create a new message each time a report or document is executed.
From interface com.microstrategy.web.objects.WebStatement abstract int getStatementType() Returns the current statement type.