public class

MWSExecutionUtils

extends Object
java.lang.Object
   ↳ com.microstrategy.webservices.MWSExecutionUtils

Class Overview

Provides common functionality to execution class objects.

Summary

Fields
public static String MWSEXECUTIONUTILS
public static int MWSHTMLDOCUMENT
public static int MWSREPORT
public static int MWSRSDOCUMENT
Public Constructors
MWSExecutionUtils()
Public Methods
static String GetMsgIDFromState(MWSConnection connection, String sInput, int iType)
This method returns the message id of the report or document represented by the input state string.
static RWInstance GetRWInstance(MWSConnection connection, RWSource rsSource, String sInput)
This method restores or gets a RWInstance instance based on input message id.
static WebReportInstance GetReportInstance(MWSConnection connection, WebReportSource reportSource, String sInput, int iStateID)
This method restores or gets a WebReportInstance instance based on input message id.
static boolean IsRIState(String sInput)
This method returns true if the input string is an instance state, false if message id.
static String ManipulateUserAnswer(MWSConnectInfo cInfo, String commandXML)
This method loads, edits and saves user prompt answers.
static void ModifyHistoryListMessage(MWSConnection connection, String sMsgID, EnumMWSHistoryListAction eType)
This method clears the history list, or deletes or changes the status of a history list message.
static void RenameHistoryListMessage(MWSConnection connection, String sMsgID, String sName)
This method renames a history list message.
static String mapWUExecutionToString(int wuExecution)
Outputs a string representation of the input EnumDSSXMLExecutionFlags values
static String mapWUResultsToString(int wuResults)
Outputs a string representation of the input EnumDSSXMLResultFlags values
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static String MWSEXECUTIONUTILS

public static int MWSHTMLDOCUMENT

public static int MWSREPORT

public static int MWSRSDOCUMENT

Public Constructors

public MWSExecutionUtils ()

Public Methods

public static String GetMsgIDFromState (MWSConnection connection, String sInput, int iType)

This method returns the message id of the report or document represented by the input state string.

Parameters
connection connection information.
sInput representing state info
iType indicates if the state represents a report or document instance
Returns
  • String representing the message id of the instance who's state info was input.
Throws
RemoteException
MWSException

public static RWInstance GetRWInstance (MWSConnection connection, RWSource rsSource, String sInput)

This method restores or gets a RWInstance instance based on input message id.

Parameters
connection connection information.
rsSource representing an existing rw source instance
sInput representing a message id or RWinstance state info
Returns
  • RWInstance representing the instance corresponding to the input string.
Throws
RemoteException
MWSException

public static WebReportInstance GetReportInstance (MWSConnection connection, WebReportSource reportSource, String sInput, int iStateID)

This method restores or gets a WebReportInstance instance based on input message id.

Parameters
connection information.
reportSource representing an existing report source instance
sInput representing a message id or report instance state info
iStateID representing a specific state id to return
Returns
  • WebReportInstance representing the report instance corresponding to the input string.
Throws
RemoteException
MWSException

public static boolean IsRIState (String sInput)

This method returns true if the input string is an instance state, false if message id.

Parameters
sInput String representing a message id or instance state info
Returns
  • boolean indicating if the input string is an instance state or not.
Throws
RemoteException
MWSException

public static String ManipulateUserAnswer (MWSConnectInfo cInfo, String commandXML)

This method loads, edits and saves user prompt answers.

Parameters
cInfo Session connection information.
commandXML representing the input command XML
Returns
  • String representing the resultant prompt answer XML
Throws
RemoteException
MWSException

public static void ModifyHistoryListMessage (MWSConnection connection, String sMsgID, EnumMWSHistoryListAction eType)

This method clears the history list, or deletes or changes the status of a history list message.

Parameters
connection connection information.
sMsgID representing the message id
eType representing the action to be performed
Throws
RemoteException
MWSException

public static void RenameHistoryListMessage (MWSConnection connection, String sMsgID, String sName)

This method renames a history list message.

Parameters
connection connection information.
sMsgID representing the message id
sName representing the new message name
Throws
RemoteException
MWSException

public static String mapWUExecutionToString (int wuExecution)

Outputs a string representation of the input EnumDSSXMLExecutionFlags values

Parameters
wuExecution The execution flag values to convert.
Returns
  • The converted values in a string.

public static String mapWUResultsToString (int wuResults)

Outputs a string representation of the input EnumDSSXMLResultFlags values

Parameters
wuResults The result flag values to convert.
Returns
  • The converted values in a string.