public class

MWSUAPI

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

Summary

Public Constructors
MWSUAPI()
Public Methods
void cancelBrowse(MWSConnectInfo cInfo, String sBrowseID)
Cancels the specifed object browse (search).
void cancelDocument(MWSConnectInfo cInfo, String sMsgID)
Cancels the asynchronous execution of a document.
void cancelRSDocument(MWSConnectInfo cInfo, String sMsgID)
Cancels the asynchronous execution of a RS document.
void cancelReport(MWSConnectInfo cInfo, String sMsgID)
Cancels the asynchronous execution of a report.
void changeUserPassword(MWSConnectInfo cInfo, String newPassword)
Creates a temporary connection used to change the specified user password.
String connect(MWSConnectInfo cInfo)
Creates an IServer session based on passed in connection information and returns a session string.
MWSProjectSessionInfo connectToProject(MWSConnectInfo cInfo)
Creates an IServer session based on passed in connection information and returns project information.
void copyObjects(MWSConnectInfo cInfo, String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
String createFolder(MWSConnectInfo cInfo, String parentFolderID, String folderName, String folderDesc)
void createShortcuts(MWSConnectInfo cInfo, String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
void deleteObjects(MWSConnectInfo cInfo, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
void disconnect(ArrayOfString sessions)
Given an array of session strings, dsconnect them all.
ArrayOfMWSDiscoverRow discover(MWSConnectInfo cInfo, EnumMWSRequestType eType, ArrayOfMWSProperty aProps, ArrayOfMWSRestriction aRestricts)
Not implemented.
MWSElementBrowseInfo drillDocumentPromptElement(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)
Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions.
MWSElementBrowseInfo drillRSDocumentPromptElement(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)
Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions.
MWSElementBrowseInfo drillReportPromptElement(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)
Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions.
void establishTrust(MWSConnectInfo cInfo, boolean bDelete)
MWSObjectExecuteInfo executeDocument(MWSConnectInfo cInfo, String sDocName, String sDocID, String sAnswerPrompt, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)
Runs the specified document based on input execution flags.
MWSBrowseInfo executeIncrementalBrowse(MWSConnectInfo cInfo, ArrayOfMWSRestriction aRestricts, ArrayOfEnumMWSObjectType eType, ArrayOfEnumMWSObjSubType eStype, EnumMWSSearchFlags eFlags, ArrayOfMWSSyncCommunicationSetting aSyncSettings, int iStartIndex, int iCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)
MWSObjectExecuteInfo executeRSDocument(MWSConnectInfo cInfo, String sDocName, String sDocID, String sAnswerPrompt, EnumMWSRSExecutionFlags eFlags, EnumMWSRSResultFlags eFormat, MWSRSExecutionSettings eSettings)
Runs the specified document based on input execution flags.
MWSExecuteInfo executeReport(MWSConnectInfo cInfo, String sReportName, String sReportID, String sAnswerPrompt, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, String sStyle, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)
Runs the specified report based on input execution flags.
ArrayOfMWSHierarchyAttributeInfo getAttributeChildren(MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)
Uses passed in attribute information to specify a hierarchy and attribute.
MWSElementBrowseInfo getAttributeElements(MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)
Retrieves elements from the specified attribute based on specified element filter restrictions.
ArrayOfMWSHierarchyAttributeInfo getAttributeParents(MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)
Uses passed in attribute information to specify a hierarchy and attribute.
byte[] getBytes()
int getCSVArraySize()
Returns the size of the CSV string array.
String getCSVString(int index)
Returns the CSV string at the desired index.
ArrayOfMWSObjectInfo getContents(MWSConnectInfo cInfo, String folderID, ArrayOfEnumMWSObjectType eTypes, ArrayOfEnumMWSObjSubType eSTypes, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)
Returns an array of objects that exist in the specified folder.
ArrayOfMWSObjectInfoProperty getDMXMetricFunctionProperties(MWSConnectInfo cInfo, String dmxMetricObjID)
MWSElementBrowseInfo getDocumentPromptElements(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)
Retrieves elements from the specified document prompt based on specified element filter restrictions.
MWSObjectExecuteInfo getDocumentResults(MWSConnectInfo cInfo, String sPrompt, String sDocID, String sMsgID, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)
Checks the status of an executing document.
ArrayOfMWSHierarchyAttributeInfo getHierarchyAttributes(MWSConnectInfo cInfo, String sHierarchyID, EnumMWSAttributeFormsSetting eForms)
Uses the passed in hierarchy ID to specify a hierarchy, and then returns all the attributes associated with that hierarchy.
ArrayOfMWSHistoryInfo getHistory(MWSConnectInfo cInfo)
Returns a list of history objects from the user's inbox.
byte[] getImageArray(int index)
Returns the specified byte array.
int getImageArraySize()
Returns the size of the array of bytes array.
MWSBrowseInfo getIncrementalBrowseResults(MWSConnectInfo cInfo, String sBrowseID, ArrayOfMWSSyncCommunicationSetting aSyncSettings, int iStartIndex, int iCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)
ArrayOfMWSFunctionalityProperty getMWSFunctionalityProperties(String clientWSDLVersion, String displayLocale)
Returns the specified web service functionalityproperties.
String getMWSIdentity()
Return web service identity (wsdl version).
ArrayOfMWSInfoProperty getMWSInfoProperties(String clientWSDLVersion, String displayLocale)
Returns the specified web service informational properties.
MWSOfficeInstallInfo getMWSOfficeInstallInfo()
Returns Office install exectable information so that client can decide whether to upgrade their version of MicroStrategy Office.
ArrayOfMWSProperty getMWSProperties(EnumMWSProperties eProps, ArrayOfMWSConnectProperty aConnectProps)
Returns the specified web service properties.
ArrayOfMWSObjectInfoPropertySetGroup getObjectProperties(MWSConnectInfo cInfo, ArrayOfMWSObjectInfoPropertySetGroup arrOfPropSetGrp)
MWSObjectInfo getProjectFolder(MWSConnectInfo cInfo, EnumMWSProjectFolder eFolder)
Return object information related to a specified project folder.
ArrayOfMWSProjectSourceInfo getProjectSources()
Gets a list of project sources and related info from the projectsources.xml file.
ArrayOfMWSProjectInfo getProjects(MWSConnectInfo cInfo)
Connects to a project source and then returns a list of related projects with project information.
String getRSDocumentAnnotations(MWSConnectInfo cInfo, String rsDocumentObjID)
MWSElementBrowseInfo getRSDocumentPromptElements(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)
Retrieves elements from the specified report services document prompt based on specified element filter restrictions.
MWSObjectExecuteInfo getRSDocumentResults(MWSConnectInfo cInfo, String sPrompt, String sDocID, String sMsgID, EnumMWSRSExecutionFlags eFlags, EnumMWSRSResultFlags eFormat, MWSRSExecutionSettings eSettings)
Checks the status of an executing document.
String getReportAnnotations(MWSConnectInfo cInfo, String reportObjID)
MWSElementBrowseInfo getReportPromptElements(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)
Retrieves elements from the specified report prompt based on specified element filter restrictions.
MWSExecuteInfo getReportResults(MWSConnectInfo cInfo, String sPrompt, String sRptID, String sMsgID, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, String sStyle, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)
Checks the status of an executing report.
ArrayOfMWSResourceReturnInfo getResources(ArrayOfMWSResourceRequestInfo arrayResources)
Retrieve one or more specified resources
ArrayOfMWSUserPreference getUserPreferences(MWSConnectInfo cInfo, ArrayOfMWSUserPreference arrOfPref)
Gets user preferences associated with the user session.
ArrayOfMWSVisualizationList getVisualizationLists(MWSConnectInfo cInfo, int viewMode)
Retrieves one visualization list for every view mode specified.
int getXMLArraySize()
Returns the size of the XML string array.
String getXMLString(int index)
Returns the XML string at the desired index.
boolean isSessionValid(MWSConnectInfo cInfo)
String manipulateUserAnswer(MWSConnectInfo cInfo, String commandXML)
This method loads, edits and saves user prompt answers.
void modifyHistoryListMessages(MWSConnectInfo cInfo, String sMsgID, EnumMWSHistoryListAction eType)
This method provides the ability to clear, delete and change status of history list message(s).
void moveObjects(MWSConnectInfo cInfo, String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
void renameHistoryListMessage(MWSConnectInfo cInfo, String sMsgID, String sName)
This method renames the specified message id on the history list.
void renameObject(MWSConnectInfo cInfo, String objectID, EnumMWSObjectType objectType, String newName)
void setConnectionPoolSize(String serverName, int portNum, int poolSize)
void setContainerServices(ContainerServices cs)
Currently ContainerServices is used for accessing GSS delegate credential stored in HTTP session.
void setRSDocumentAnnotations(MWSConnectInfo cInfo, String rsDocumentObjID, String annotations)
void setReportAnnotations(MWSConnectInfo cInfo, String reportObjID, String annotations)
void setRequestTimeOut(int timeout)
void setServerBusyTimeOut(int timeout)
String transformXML(String sXSLFile, String sXML)
Transform the supplied XML into HTML using the supplied XSL file path.
boolean trustRelationshipExists(String serverName)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSUAPI ()

Public Methods

public void cancelBrowse (MWSConnectInfo cInfo, String sBrowseID)

Cancels the specifed object browse (search).

Parameters
cInfo Session connection information
sBrowseID ID of Browse to cancel.
Throws
RemoteException

public void cancelDocument (MWSConnectInfo cInfo, String sMsgID)

Cancels the asynchronous execution of a document.

Parameters
cInfo Session connection information
sMsgID string representing the message id associated with the document
Throws
RemoteException

public void cancelRSDocument (MWSConnectInfo cInfo, String sMsgID)

Cancels the asynchronous execution of a RS document.

Parameters
cInfo Session connection information
sMsgID string representing the message id associated with the document
Throws
RemoteException

public void cancelReport (MWSConnectInfo cInfo, String sMsgID)

Cancels the asynchronous execution of a report.

Parameters
cInfo Session connection information
sMsgID string representing the message id associated with the report
Throws
RemoteException

public void changeUserPassword (MWSConnectInfo cInfo, String newPassword)

Creates a temporary connection used to change the specified user password.

Parameters
cInfo connection info
newPassword password to change to
Throws
java.rmi.RemoteException
RemoteException

public String connect (MWSConnectInfo cInfo)

Creates an IServer session based on passed in connection information and returns a session string.

Parameters
cInfo Session connection information.
Returns
  • Serialized session string.
Throws
RemoteException

public MWSProjectSessionInfo connectToProject (MWSConnectInfo cInfo)

Creates an IServer session based on passed in connection information and returns project information.

Parameters
cInfo Session connection information.
Returns
  • MWSProjectSessionInfo object.
Throws
RemoteException

public void copyObjects (MWSConnectInfo cInfo, String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
RemoteException

public String createFolder (MWSConnectInfo cInfo, String parentFolderID, String folderName, String folderDesc)

Throws
RemoteException

public void createShortcuts (MWSConnectInfo cInfo, String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
RemoteException

public void deleteObjects (MWSConnectInfo cInfo, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
RemoteException

public void disconnect (ArrayOfString sessions)

Given an array of session strings, dsconnect them all.

Parameters
sessions Array of serialized session strings.
Throws
RemoteException

public ArrayOfMWSDiscoverRow discover (MWSConnectInfo cInfo, EnumMWSRequestType eType, ArrayOfMWSProperty aProps, ArrayOfMWSRestriction aRestricts)

Not implemented.

Throws
RemoteException

public MWSElementBrowseInfo drillDocumentPromptElement (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)

Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is retrieved from the document prompt so that cube attributes can be browsed.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
fromElementFilters Identifies the element(s) to drill from.
toAttributeInfo Identifies the attribute to get drill to.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
Returns
  • Structure containing an element array and other status info.
Throws
java.rmi.RemoteException
RemoteException

public MWSElementBrowseInfo drillRSDocumentPromptElement (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)

Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is retrieved from the report services document prompt so that cube attributes can be browsed.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
fromElementFilters Identifies the element(s) to drill from.
toAttributeInfo Identifies the attribute to get drill to.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
Returns
  • Structure containing an element array and other status info.
Throws
java.rmi.RemoteException
RemoteException

public MWSElementBrowseInfo drillReportPromptElement (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)

Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is retrieved from the report prompt so that cube attributes can be browsed.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
fromElementFilters Identifies the element(s) to drill from.
toAttributeInfo Identifies the attribute to get drill to.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
Returns
  • Structure containing an element array and other status info.
Throws
java.rmi.RemoteException
RemoteException

public void establishTrust (MWSConnectInfo cInfo, boolean bDelete)

Throws
RemoteException

public MWSObjectExecuteInfo executeDocument (MWSConnectInfo cInfo, String sDocName, String sDocID, String sAnswerPrompt, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)

Runs the specified document based on input execution flags.

Parameters
cInfo Session connection information
sDocName string representing the document name (optional)
sDocID string representing the document id (optional if name input)
sAnswerPrompt answer prompt xml to run document with.
eFlags specifies options to execute document with
resultsWindow specifies results window options such as number of rows, columns, or page by info
eResults specifies options to apply to report results
Returns
  • MWSObjectExecuteInfo structure containing results and status
Throws
java.rmi.RemoteException
RemoteException

public MWSBrowseInfo executeIncrementalBrowse (MWSConnectInfo cInfo, ArrayOfMWSRestriction aRestricts, ArrayOfEnumMWSObjectType eType, ArrayOfEnumMWSObjSubType eStype, EnumMWSSearchFlags eFlags, ArrayOfMWSSyncCommunicationSetting aSyncSettings, int iStartIndex, int iCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)

Parameters
cInfo Session connection information
aRestricts Addtional search restrictions to apply while searching
eType Types of objects to return
eStype Subtypes of objects to return
eFlags Additional search flags
aSyncSettings Synchronous/asynchronous settings
iStartIndex Start index of objects to return this time
iCount Number of object to return this time
aPropSetSpecs Array of type/subtype mapped to property sets to return
Throws
java.rmi.RemoteException
RemoteException

public MWSObjectExecuteInfo executeRSDocument (MWSConnectInfo cInfo, String sDocName, String sDocID, String sAnswerPrompt, EnumMWSRSExecutionFlags eFlags, EnumMWSRSResultFlags eFormat, MWSRSExecutionSettings eSettings)

Runs the specified document based on input execution flags.

Parameters
cInfo Session connection information
sDocName string representing the document name (optional)
sDocID string representing the document id (optional if name input)
sAnswerPrompt answer prompt xml to run document with.
eFlags specifies options to execute document with
eFormat species format of results
Returns
  • MWSObjectExecuteInfo structure containing results and status
Throws
java.rmi.RemoteException
RemoteException

public MWSExecuteInfo executeReport (MWSConnectInfo cInfo, String sReportName, String sReportID, String sAnswerPrompt, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, String sStyle, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)

Runs the specified report based on input execution flags.

Parameters
cInfo Session connection information
sReportName string representing the report name (optional)
sReportID string representing the report id (optional if name input)
sAnswerPrompt answer prompt xml to run report with.
eFlags specifies options to execute report with
resultsWindow specifies results window options such as number of rows, columns, or page by info
sStyle string representing the style to use for transformations
eResults specifies options to apply to report results
Returns
  • MWSExecuteInfo structure containing results and status
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSHierarchyAttributeInfo getAttributeChildren (MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)

Uses passed in attribute information to specify a hierarchy and attribute. The children of the specified attribute are returned.

Parameters
cInfo Session connection information
attributeInfo Identifies the attribute to get children of.
eForms Determines which form data is included.
Returns
  • An array of attribute information.
Throws
java.rmi.RemoteException
RemoteException

public MWSElementBrowseInfo getAttributeElements (MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)

Retrieves elements from the specified attribute based on specified element filter restrictions. Elements can be retrieved incrementally.

Parameters
cInfo Session connection information
attributeInfo Identifies the attribute to get elements from.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
Returns
  • Structure containing an element array and other status info.
Throws
RemoteException

public ArrayOfMWSHierarchyAttributeInfo getAttributeParents (MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)

Uses passed in attribute information to specify a hierarchy and attribute. The parents of the specified attribute are returned.

Parameters
cInfo Session connection information
attributeInfo Identifies the attribute to get parents of.
eForms Determines which form data is included.
Returns
  • An array of attribute information.
Throws
java.rmi.RemoteException
RemoteException

public byte[] getBytes ()

Throws
RemoteException

public int getCSVArraySize ()

Returns the size of the CSV string array.

Returns
  • int representing size of CSV string array

public String getCSVString (int index)

Returns the CSV string at the desired index.

Parameters
index int Index of CSV string to return
Returns
  • string representing the CSV string

public ArrayOfMWSObjectInfo getContents (MWSConnectInfo cInfo, String folderID, ArrayOfEnumMWSObjectType eTypes, ArrayOfEnumMWSObjSubType eSTypes, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)

Returns an array of objects that exist in the specified folder. The types/subtypes of objects returned can be specified.

Parameters
cInfo Session connection information
folderID ID of folder to browse
eTypes Types of objects to return
eSTypes Subtypes of objects to return
aPropSetSpecs Array of type/subtype mapped to property sets to return.
Returns
  • Array of objects.
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSObjectInfoProperty getDMXMetricFunctionProperties (MWSConnectInfo cInfo, String dmxMetricObjID)

Throws
RemoteException

public MWSElementBrowseInfo getDocumentPromptElements (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)

Retrieves elements from the specified document prompt based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is the attribute found in the prompt. If the prompt describes a dimension, the attributeInfo parameter describes which attribute in the dimension to use.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
attributeInfo Identifies the attribute to get elements from.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
dataSourcesXML Specifies the Data Sources XML if the elements come from a MDX prompt.
Returns
  • Structure containing an element array and other status info.
Throws
java.rmi.RemoteException
RemoteException

public MWSObjectExecuteInfo getDocumentResults (MWSConnectInfo cInfo, String sPrompt, String sDocID, String sMsgID, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)

Checks the status of an executing document. If results are available, return the result to client. In a prompted document, the prompt XML is returned to the client. The subsequent call to this method contains the prompt answer, which is submitted to the I-Server and execution continues.

Parameters
cInfo Session connection information
sPrompt answer prompt xml to run document with.
sDocID string representing the object id associated with the document
sMsgID string representing the message id associated with the document
eFlags specifies options to execute document with
resultsWindow specifies results window options such as number of rows, columns, or page by info
eResults specifies options to apply to report results
Returns
  • MWSObjectExecuteInfo structure containing results and status
Throws
RemoteException

public ArrayOfMWSHierarchyAttributeInfo getHierarchyAttributes (MWSConnectInfo cInfo, String sHierarchyID, EnumMWSAttributeFormsSetting eForms)

Uses the passed in hierarchy ID to specify a hierarchy, and then returns all the attributes associated with that hierarchy.

Parameters
cInfo Session connection information
sHierarchyID DSSID of hierarchy to get attributes of.
eForms Determines which form data is included.
Returns
  • An array of attribute information.
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSHistoryInfo getHistory (MWSConnectInfo cInfo)

Returns a list of history objects from the user's inbox. Normally, these are reports/documents that have been run.

Parameters
cInfo Session connection information
Returns
  • Array of found history objects.
Throws
RemoteException

public byte[] getImageArray (int index)

Returns the specified byte array.

Returns
  • byte[] representing the specified byte array.

public int getImageArraySize ()

Returns the size of the array of bytes array.

Returns
  • int representing size of array of bytes array

public MWSBrowseInfo getIncrementalBrowseResults (MWSConnectInfo cInfo, String sBrowseID, ArrayOfMWSSyncCommunicationSetting aSyncSettings, int iStartIndex, int iCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)

Parameters
cInfo Session connection information
aSyncSettings Synchronous/asynchronous settings
iStartIndex Start index of objects to return this time
iCount Number of object to return this time
aPropSetSpecs Array of type/subtype mapped to property sets to return
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSFunctionalityProperty getMWSFunctionalityProperties (String clientWSDLVersion, String displayLocale)

Returns the specified web service functionalityproperties.

Parameters
clientWSDLVersion - callers wsdl version
displayLocale - locale ID for error display (eg. "1033" English)
Returns
  • Array of properties.
Throws
java.rmi.RemoteException
RemoteException

public String getMWSIdentity ()

Return web service identity (wsdl version). Immutable interface.

Returns
  • string wsdl version
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSInfoProperty getMWSInfoProperties (String clientWSDLVersion, String displayLocale)

Returns the specified web service informational properties.

Parameters
clientWSDLVersion - callers wsdl version
displayLocale - locale ID for error display (eg. "1033" English)
Returns
  • Array of properties.
Throws
java.rmi.RemoteException
RemoteException

public MWSOfficeInstallInfo getMWSOfficeInstallInfo ()

Returns Office install exectable information so that client can decide whether to upgrade their version of MicroStrategy Office.

Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSProperty getMWSProperties (EnumMWSProperties eProps, ArrayOfMWSConnectProperty aConnectProps)

Returns the specified web service properties.

Parameters
eProps Enum specifying the properties to return.
Returns
  • Array of properties.
Throws
RemoteException

public ArrayOfMWSObjectInfoPropertySetGroup getObjectProperties (MWSConnectInfo cInfo, ArrayOfMWSObjectInfoPropertySetGroup arrOfPropSetGrp)

Throws
java.rmi.RemoteException
RemoteException

public MWSObjectInfo getProjectFolder (MWSConnectInfo cInfo, EnumMWSProjectFolder eFolder)

Return object information related to a specified project folder.

Parameters
cInfo Session connection info.
eFolder Project folder specifier
Returns
  • folder information
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSProjectSourceInfo getProjectSources ()

Gets a list of project sources and related info from the projectsources.xml file.

Returns
  • Array of project sources.
Throws
RemoteException

public ArrayOfMWSProjectInfo getProjects (MWSConnectInfo cInfo)

Connects to a project source and then returns a list of related projects with project information.

Parameters
cInfo Session connection information
Returns
  • Array of projects.
Throws
RemoteException

public String getRSDocumentAnnotations (MWSConnectInfo cInfo, String rsDocumentObjID)

Throws
RemoteException

public MWSElementBrowseInfo getRSDocumentPromptElements (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)

Retrieves elements from the specified report services document prompt based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is the attribute found in the prompt. If the prompt describes a dimension, the attributeInfo parameter describes which attribute in the dimension to use.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
attributeInfo Identifies the attribute to get elements from.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
dataSourcesXML Specifies the Data Sources XML if the elements come from a MDX prompt.
Returns
  • Structure containing an element array and other status info.
Throws
java.rmi.RemoteException
RemoteException

public MWSObjectExecuteInfo getRSDocumentResults (MWSConnectInfo cInfo, String sPrompt, String sDocID, String sMsgID, EnumMWSRSExecutionFlags eFlags, EnumMWSRSResultFlags eFormat, MWSRSExecutionSettings eSettings)

Checks the status of an executing document. If results are available, return the result to client. In a prompted document, the prompt XML is returned to the client. The subsequent call to this method contains the prompt answer, which is submitted to the I-Server and execution continues.

Parameters
cInfo Session connection information
sPrompt answer prompt xml to run document with.
sDocID string representing the object id associated with the document
sMsgID string representing the message id associated with the document
eFlags specifies options to execute document with
Returns
  • MWSObjectExecuteInfo structure containing results and status
Throws
RemoteException

public String getReportAnnotations (MWSConnectInfo cInfo, String reportObjID)

Throws
RemoteException

public MWSElementBrowseInfo getReportPromptElements (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)

Retrieves elements from the specified report prompt based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is the attribute found in the prompt. If the prompt describes a dimension, the attributeInfo parameter describes which attribute in the dimension to use.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
attributeInfo Identifies the attribute to get elements from.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
dataSourcesXML Specifies the Data Sources XML if the elements come from a MDX prompt.
Returns
  • Structure containing an element array and other status info.
Throws
java.rmi.RemoteException
RemoteException

public MWSExecuteInfo getReportResults (MWSConnectInfo cInfo, String sPrompt, String sRptID, String sMsgID, EnumMWSExecutionFlags eFlags, MWSResultsWindow resultsWindow, String sStyle, EnumMWSResultFlags eResults, MWSExecutionSettings eSettings)

Checks the status of an executing report. If results are available, return the result to client. In a prompted report, the prompt XML is returned to the client. The subsequent call to this method contains the prompt answer, which is submitted to the I-Server and execution continues.

Parameters
cInfo Session connection information
sPrompt answer prompt xml to continue execution with.
sRptID string representing the report id
sMsgID string representing the message id from the initial execution
eFlags specifies options to execute report with
resultsWindow specifies results window options such as number of rows, columns, or page by info
sStyle string representing the style to use for transformations
eResults specifies options to apply to report results
Returns
  • MWSExecuteInfo structure containing results and status
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSResourceReturnInfo getResources (ArrayOfMWSResourceRequestInfo arrayResources)

Retrieve one or more specified resources

Parameters
arrayResources list of one or more resources to fetch
Returns
  • array of resource request result information
Throws
RemoteException

public ArrayOfMWSUserPreference getUserPreferences (MWSConnectInfo cInfo, ArrayOfMWSUserPreference arrOfPref)

Gets user preferences associated with the user session.

Parameters
cInfo session connection information
arrOfPref specifies preferences to retrieve
Returns
  • array of preferences
Throws
java.rmi.RemoteException
RemoteException

public ArrayOfMWSVisualizationList getVisualizationLists (MWSConnectInfo cInfo, int viewMode)

Retrieves one visualization list for every view mode specified. The user can specify one view mode, or all (-1). Information is read from visualizations.xml file.

Parameters
cInfo Session connect information
viewMode Type of visualization (eg. flash)
Returns
  • ArrayOfMWSVisualizationList
Throws
RemoteException

public int getXMLArraySize ()

Returns the size of the XML string array.

Returns
  • int representing size of XML string array

public String getXMLString (int index)

Returns the XML string at the desired index.

Parameters
index int Index of XML string to return
Returns
  • string representing the XML string

public boolean isSessionValid (MWSConnectInfo cInfo)

Throws
RemoteException

public 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
java.rmi.RemoteException
RemoteException

public void modifyHistoryListMessages (MWSConnectInfo cInfo, String sMsgID, EnumMWSHistoryListAction eType)

This method provides the ability to clear, delete and change status of history list message(s).

Parameters
cInfo Session connection information.
sMsgID representing the message ID to perform the specified action on
eType represents the action to be performed (clear/delete/mark read/mark unread
Throws
java.rmi.RemoteException
RemoteException

public void moveObjects (MWSConnectInfo cInfo, String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
RemoteException

public void renameHistoryListMessage (MWSConnectInfo cInfo, String sMsgID, String sName)

This method renames the specified message id on the history list.

Parameters
cInfo MWSConnectInfo Session connection information.
sMsgID String representing message ID of the history list item to be renamed
sName String representing the new name for the specified message id
Throws
java.rmi.RemoteException
RemoteException

public void renameObject (MWSConnectInfo cInfo, String objectID, EnumMWSObjectType objectType, String newName)

Throws
RemoteException

public void setConnectionPoolSize (String serverName, int portNum, int poolSize)

public void setContainerServices (ContainerServices cs)

Currently ContainerServices is used for accessing GSS delegate credential stored in HTTP session. The credential is used by Kerberos authentication in MWS J2EE. In .Net case this will not be called by the bridge and _containerServices will keeps null.

Parameters
cs ContainerServices

public void setRSDocumentAnnotations (MWSConnectInfo cInfo, String rsDocumentObjID, String annotations)

Throws
RemoteException

public void setReportAnnotations (MWSConnectInfo cInfo, String reportObjID, String annotations)

Throws
RemoteException

public void setRequestTimeOut (int timeout)

public void setServerBusyTimeOut (int timeout)

public String transformXML (String sXSLFile, String sXML)

Transform the supplied XML into HTML using the supplied XSL file path.

Parameters
sXSLFile XSL file path containing transformation rules
sXML XML to be transformed
Returns
  • HTML version of supplied XML
Throws
RemoteException

public boolean trustRelationshipExists (String serverName)

Throws
RemoteException