Package com.microstrategy.web.objects
Interface WebContentStatement
-
- All Superinterfaces:
WebStatement
- All Known Subinterfaces:
WebDocumentStatement
,WebReportStatement
public interface WebContentStatement extends WebStatement
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.This interface defines a report/document statement which is used to identify a server command within a schedule that targets a Report/Document. This object cannot be directly instantiated, and can only be obtained indirectly from the other scheduling-related objects. A WebContentStatement can used to read(from IServer) or fill up(for new schedules) properties common to report/document schedules. This class is further extended byWebReportStatement
andWebDocumentStatement
which hold further specific information corresponding to report and document schedules respectively.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getExecutionFlags()
Deprecated.This method returns the current value for the execution flags the Intelligence Server will usejava.lang.String
getMessageID()
Deprecated.Returns the current inbox message ID being used by this statement, if applicable.WebPrompts
getPrompts()
Deprecated.Returns theWebPrompts
object corresponding to the Report or Document.boolean
getReuseMessage()
Deprecated.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.WebObjectInfo
getTarget()
Deprecated.Returns aWebObjectInfo
object, which provides additional information on the report or document object rooted in the statement.boolean
hasPromptPersonalization()
Deprecated.This method is used to check whether the current schedule has prompts or not.boolean
isMobileEnabled()
Deprecated.boolean
isResolved()
Deprecated.If the answers for the prompts of an existing report/document are modified (callinggetPrompts()
) 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.void
reprompt()
Deprecated.Reopens the prompts if they have already been answered.void
setExecutionFlags(int executionFlags)
Deprecated.This method allows the user to specify the execution flags the Intelligence Server will use.void
setMobileEnabled(boolean isMobile)
Deprecated.void
setReuseMessage(boolean reuseMessage)
Deprecated.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.-
Methods inherited from interface com.microstrategy.web.objects.WebStatement
getStatementType
-
-
-
-
Method Detail
-
getTarget
WebObjectInfo getTarget()
Deprecated.Returns aWebObjectInfo
object, which provides additional information on the report or document object rooted in the statement.- Returns:
- An object of
WebObjectInfo
, populated with relevant information about this statement object.
-
getMessageID
java.lang.String getMessageID()
Deprecated.Returns the current inbox message ID being used by this statement, if applicable.- Returns:
- An inbox message ID.
-
getReuseMessage
boolean getReuseMessage()
Deprecated.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. By default, this value is false.- Returns:
- The current value of the reuseMessage flag.
-
setReuseMessage
void setReuseMessage(boolean reuseMessage)
Deprecated.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.- Parameters:
reuseMessage
- The value to use for the reuseMessage flag.
-
getExecutionFlags
int getExecutionFlags()
Deprecated.This method returns the current value for the execution flags the Intelligence Server will use- Returns:
- The current execution flags value.
-
setExecutionFlags
void setExecutionFlags(int executionFlags)
Deprecated.This method allows the user to specify the execution flags the Intelligence Server will use.- Parameters:
executionFlags
- The execution flags value to use when executing the statement.- See Also:
Enumeration of the possible execution flags for WebReportStatement
-
hasPromptPersonalization
boolean hasPromptPersonalization() throws WebObjectsException
Deprecated.This method is used to check whether the current schedule has prompts or not.- Returns:
- True if the current schedule(new or existing) has prompts.
- Throws:
WebObjectsException
- if an exception has been encountered on the IServer while checking whether the report corresponding to the schedule is prompted or not.
-
getPrompts
WebPrompts getPrompts() throws WebObjectsException
Deprecated.Returns theWebPrompts
object corresponding to the Report or Document. If the report or document is not prompted, it will return null. Once a client has called getPrompts on an existing Report/Document the corresponding Prompts object is returned with all prompts open. Thus, before saving such a schedule, one must therefore validate whether the prompts are resolved or not usingisResolved()
.- Returns:
- The current
WebPrompts
object. - Throws:
WebObjectsException
- if ISErver encountered an error while retrieving the prompts object.
-
isResolved
boolean isResolved() throws WebObjectsException
Deprecated.If the answers for the prompts of an existing report/document are modified (callinggetPrompts()
) 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.- Returns:
- True [1] if either the report/document is not prompted, or [2] if the client choose not to edit the prompts for an existing schedule or [3] neither [1] or [2] hold true and the client has answered all the open prompts and the report/document status is ready. False otherwise.
- Throws:
WebObjectsException
- if the the status collection from IServer resulted in error.
-
reprompt
void reprompt() throws WebObjectsException
Deprecated.Reopens the prompts if they have already been answered. The underlying content instance needs to be in a result status for this to take effect. If the status is not result, then a WebObjectsException is thrown- Throws:
WebObjectsException
- thrown if the underlying content instance is not in a ready status or if there is any other error while trying to reload the prompts- Since:
- MicroStrategy Web 8.0.0
-
isMobileEnabled
boolean isMobileEnabled()
Deprecated.- Since:
- MicroStrategy Web 8.1.1
-
setMobileEnabled
void setMobileEnabled(boolean isMobile)
Deprecated.- Since:
- MicroStrategy Web 8.1.1
-
-