public class

MWSBrowser

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

Class Overview

Provides MSTR Web Service Browser functionality including incremental synchronous/asynchronous object search, history list object retrieval, and attribute element retrieval.

Summary

Public Constructors
MWSBrowser()
This constructor is deprecated. use MWSBrowser(MWSConnectInfo) instead
MWSBrowser(MWSConnectInfo cInfo)
Public Methods
void BrowserCancelBrowse(String sBrowseID)
Cancels an outstanding find/browse (search) request.
ArrayOfMWSObjectInfo BrowserGetContents(String folderID, ArrayOfEnumMWSObjectType arrObjtype, ArrayOfEnumMWSObjSubType arrObjSubtype, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)
Browse the contents of the given folder and return objects of specified types/subtypes.
ArrayOfMWSHistoryInfo BrowserGetHistory()
Returns the list of items in a user's InBox
void CopyObjects(String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
String CreateFolder(String parentFolderID, String folderName, String folderDesc)
Creates a folder in metadata with the given name, parent folder ID, and description.
void CreateShortcuts(String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
void DeleteObjects(ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
MWSBrowseInfo GetIncrementalBrowseResults(String sBrowseID, ArrayOfMWSSyncCommunicationSetting arrSyncSettings, int iStartIndex, int iBlockCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)
Queries for incremental browse results.
MWSObjectInfo GetProjectFolder(EnumMWSProjectFolder eFolder)
Return object information related to a specified project folder.
MWSBrowseInfo InitiateIncrementalBrowse(ArrayOfMWSRestriction arrRestricts, ArrayOfEnumMWSObjectType arrObjtype, ArrayOfEnumMWSObjSubType arrObjSubtype, EnumMWSSearchFlags eFlags, ArrayOfMWSSyncCommunicationSetting arrSyncSettings, int iStartIndex, int iBlockCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)
Initiates an incremental browse.
void MoveObjects(String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)
void RenameObject(String objectID, EnumMWSObjectType objectType, String newName)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSBrowser ()

This constructor is deprecated.
use MWSBrowser(MWSConnectInfo) instead

public MWSBrowser (MWSConnectInfo cInfo)

Throws
MWSException

Public Methods

public void BrowserCancelBrowse (String sBrowseID)

Cancels an outstanding find/browse (search) request.

Parameters
sBrowseID ID of search object.
Throws
MWSException
MWSException

public ArrayOfMWSObjectInfo BrowserGetContents (String folderID, ArrayOfEnumMWSObjectType arrObjtype, ArrayOfEnumMWSObjSubType arrObjSubtype, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)

Browse the contents of the given folder and return objects of specified types/subtypes.

Parameters
folderID ID of folder to browse
arrObjtype Array of types to browse for
arrObjSubtype Array of subtypes to browse for
Returns
  • Array of MWSObjectInfo objects
Throws
MWSException
MWSException

public ArrayOfMWSHistoryInfo BrowserGetHistory ()

Returns the list of items in a user's InBox

Returns
  • Array of Inbox history objects
Throws
MWSException

public void CopyObjects (String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
MWSException

public String CreateFolder (String parentFolderID, String folderName, String folderDesc)

Creates a folder in metadata with the given name, parent folder ID, and description.

Parameters
parentFolderID The DSS ID of the parent folder.
folderName The name to give to the folder.
folderDesc The description to give to the newly created folder.
Returns
  • The DSS ID of the newly created folder.
Throws
MWSException

public void CreateShortcuts (String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
MWSException

public void DeleteObjects (ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
MWSException

public MWSBrowseInfo GetIncrementalBrowseResults (String sBrowseID, ArrayOfMWSSyncCommunicationSetting arrSyncSettings, int iStartIndex, int iBlockCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)

Queries for incremental browse results.

Parameters
sBrowseID Unique browse/search ID
arrSyncSettings Defines mode of communication
iStartIndex Defines first object to return
iBlockCount Number of objects to return
aPropSetSpecs Defines what object properties will be returned.
Throws
MWSException
MWSException

public MWSObjectInfo GetProjectFolder (EnumMWSProjectFolder eFolder)

Return object information related to a specified project folder.

Parameters
eFolder Project folder specifier
Returns
  • folder information
Throws
MWSException
MWSException

public MWSBrowseInfo InitiateIncrementalBrowse (ArrayOfMWSRestriction arrRestricts, ArrayOfEnumMWSObjectType arrObjtype, ArrayOfEnumMWSObjSubType arrObjSubtype, EnumMWSSearchFlags eFlags, ArrayOfMWSSyncCommunicationSetting arrSyncSettings, int iStartIndex, int iBlockCount, ArrayOfMWSObjectInfoPropertySetSpec aPropSetSpecs)

Initiates an incremental browse.

Parameters
arrRestricts Path and/or pattern restrictions
arrObjtype Array of Object types to search for
arrObjSubtype Array of Object subtypes to search for
eFlags Bitwise OR of search options
arrSyncSettings Sync Comm settings
iStartIndex Index of first item to retrieve.
iBlockCount Number of items to retrieve.
aPropSetSpecs Defines what object properties will be returned.
Returns
  • MWSBrowseInfo
Throws
MWSException
MWSException

public void MoveObjects (String targetFolderID, ArrayOfString objectIDs, ArrayOfEnumMWSObjectType objectTypes)

Throws
MWSException

public void RenameObject (String objectID, EnumMWSObjectType objectType, String newName)

Throws
MWSException