public
class
MWSBrowserUtils
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.webservices.MWSBrowserUtils |
Class Overview
Provides common functionality to browser class objects.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public static String | MWSBROWSERUTILS | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| MWSBrowserUtils() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static MWSHierarchyAttributeFormInfo[] |
BuildFormsWithCategories(MWSConnection connectObj, WebAttribute wattr, EnumMWSAttributeFormsSetting eForms, WebAttributeForms requestedForms)
Process collection of forms and determine categories for each form.
| ||||||||||
| static MWSHierarchyAttributeFormInfo[] |
CreateAttributeFormArray(MWSConnection connectObj, WebAttribute wattr, EnumMWSAttributeFormsSetting eForms)
Retrieves attribute form related information from the source
attribute and creates an attribute form array.
| ||||||||||
| static MWSObjectInfo |
CreateObjectInfo(MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi, boolean bIncludeFolderPath, boolean bIncludeParentFolderID)
Creates an MWSObjectInfo object and populates it based on WebObjectInfo
contents.
| ||||||||||
| static MWSObjectInfo | CreateObjectInfoWithProperties(MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi, boolean bIncludeFolderPath, boolean bIncludeParentFolderID, ArrayOfMWSObjectInfoPropertySetSpec aOfPropSetSpecs) | ||||||||||
| static WebAttribute |
GetAttributeByID(MWSConnection connectObj, String sAttributeID)
Retrieves an attribute from the object source, and handles errors.
| ||||||||||
| static int | GetBrowseFlagSettings() | ||||||||||
| static MWSConnection |
GetConnection(MWSConnectInfo cInfo)
Create a session connection based on given session information, and
handle errors.
| ||||||||||
| static WebElements |
GetElementsFromSource(MWSConnection connectObj, WebElementSource eltSrc, String attribute, int iBlockBegin, int iBlockCount, String dataSourcesXML)
Incrementally retrieves elements from the element source, and
handles errors.
| ||||||||||
| static WebElements |
GetElementsFromSource(MWSConnection connectObj, WebElementSource eltSrc, String attribute, int iBlockBegin, int iBlockCount)
Incrementally retrieves elements from the element source, and
handles errors.
| ||||||||||
| static WebDimensionAttribute |
GetHierarchyAttributeByID(MWSConnection connectObj, WebDimension dim, String sAttributeID)
Retrieves an attribute object from its specified containing hierarchy,
and handles errors.
| ||||||||||
| static WebDimension |
GetHierarchyByID(MWSConnection connectObj, String sHierarchyID)
Retrieves a hierarchy object based on the specified hierarchy ID, and
handles errors.
| ||||||||||
| static WebPrompt | GetPrompt(MWSConnection connectObj, MWSExecutionObjSpec oSpec, String promptKey) | ||||||||||
| static WebAttribute | GetPromptSourceAttribute(MWSConnection connectObj, WebPrompt prompt, MWSHierarchyAttributeInfo attributeInfo) | ||||||||||
| static void |
PopulateAttributeInfo(MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi)
Retrieves attribute related information from the source MSTR
object and initializes fields in the constructed MWS equivalent.
| ||||||||||
| static void |
PopulateRSDocumentInfo(MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi)
Retrieves RSDocument related information from the source MSTR
object and initializes fields in the constructed MWS equivalent.
| ||||||||||
| static void |
PopulateReportInfo(MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi)
Retrieves Report related information from the source MSTR
object and initializes fields in the constructed MWS equivalent.
| ||||||||||
| static MWSObjectInfo |
PopulateShortcutInfo(MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi, ArrayOfMWSObjectInfoPropertySetSpec aOfPropSetSpecs)
Retrieves shortcut related information from the source MSTR
object and initializes fields in the constructed MWS equivalent.
| ||||||||||
| static String |
getFolderPath(MWSConnection connectObj, WebObjectInfo mstrObjectInfo)
Constructs the folderpath of the supplied object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public static String MWSBROWSERUTILS
Public Constructors
public MWSBrowserUtils ()
Public Methods
public static MWSHierarchyAttributeFormInfo[] BuildFormsWithCategories (MWSConnection connectObj, WebAttribute wattr, EnumMWSAttributeFormsSetting eForms, WebAttributeForms requestedForms)
Process collection of forms and determine categories for each form.
Parameters
| connectObj | MSTR session connect object. |
|---|---|
| wattr | Source attribute |
| eForms | Forms to retrieve |
| requestedForms | Collection of forms to be processed |
Throws
| MWSException |
|---|
public static MWSHierarchyAttributeFormInfo[] CreateAttributeFormArray (MWSConnection connectObj, WebAttribute wattr, EnumMWSAttributeFormsSetting eForms)
Retrieves attribute form related information from the source attribute and creates an attribute form array.
Parameters
| connectObj | MSTR session connect object. |
|---|---|
| wattr | Source attribute |
| eForms | Forms to retrieve |
Throws
| MWSException | |
| MWSException |
public static MWSObjectInfo CreateObjectInfo (MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi, boolean bIncludeFolderPath, boolean bIncludeParentFolderID)
Creates an MWSObjectInfo object and populates it based on WebObjectInfo contents.
Parameters
| connectObj | MSTR session connect object |
|---|---|
| woi | Source MSTR Web Object |
| bIncludeFolderPath | True if folderpath is to be calculated |
| bIncludeParentFolderID | True if parent folder ID is to be calculated |
Returns
- MWSObjectInfo object
Throws
| MWSException | |
| MWSException |
public static MWSObjectInfo CreateObjectInfoWithProperties (MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi, boolean bIncludeFolderPath, boolean bIncludeParentFolderID, ArrayOfMWSObjectInfoPropertySetSpec aOfPropSetSpecs)
Throws
| MWSException |
|---|
public static WebAttribute GetAttributeByID (MWSConnection connectObj, String sAttributeID)
Retrieves an attribute from the object source, and handles errors.
Parameters
| connectObj | Session connection object. |
|---|---|
| sAttributeID | Specified attribute ID. |
Returns
- Attribute object.
Throws
| MWSException |
|---|
public static int GetBrowseFlagSettings ()
public static MWSConnection GetConnection (MWSConnectInfo cInfo)
Create a session connection based on given session information, and handle errors.
Parameters
| cInfo | Specified session information. |
|---|
Returns
- Session connection object.
Throws
| MWSException |
|---|
public static WebElements GetElementsFromSource (MWSConnection connectObj, WebElementSource eltSrc, String attribute, int iBlockBegin, int iBlockCount, String dataSourcesXML)
Incrementally retrieves elements from the element source, and handles errors.
Parameters
| connectObj | Session connection object. |
|---|---|
| eltSrc | The element source. |
| attribute | The associated attribute name or ID. |
| iBlockBegin | Specified start element. |
| iBlockCount | Number of elements to return. |
| dataSourcesXML | Specifies the Data Sources XML if the elements come from a MDX prompt. |
Returns
- Array of element objects.
Throws
| MWSException | |
| MWSException |
public static WebElements GetElementsFromSource (MWSConnection connectObj, WebElementSource eltSrc, String attribute, int iBlockBegin, int iBlockCount)
Incrementally retrieves elements from the element source, and handles errors.
Parameters
| connectObj | Session connection object. |
|---|---|
| eltSrc | The element source. |
| attribute | The associated attribute name or ID. |
| iBlockBegin | Specified start element. |
| iBlockCount | Number of elements to return. |
Returns
- Array of element objects.
Throws
| MWSException |
|---|
public static WebDimensionAttribute GetHierarchyAttributeByID (MWSConnection connectObj, WebDimension dim, String sAttributeID)
Retrieves an attribute object from its specified containing hierarchy, and handles errors.
Parameters
| connectObj | Session connection object. |
|---|---|
| dim | Specified hierarchy. |
| sAttributeID | Specified attribute ID. |
Returns
- Attribute object.
Throws
| MWSException |
|---|
public static WebDimension GetHierarchyByID (MWSConnection connectObj, String sHierarchyID)
Retrieves a hierarchy object based on the specified hierarchy ID, and handles errors.
Parameters
| connectObj | Session connection object. |
|---|---|
| sHierarchyID | Specified hierarchy ID. |
Returns
- Hierarchy object.
Throws
| MWSException |
|---|
public static WebPrompt GetPrompt (MWSConnection connectObj, MWSExecutionObjSpec oSpec, String promptKey)
Throws
| MWSException |
|---|
public static WebAttribute GetPromptSourceAttribute (MWSConnection connectObj, WebPrompt prompt, MWSHierarchyAttributeInfo attributeInfo)
Throws
| MWSException |
|---|
public static void PopulateAttributeInfo (MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi)
Retrieves attribute related information from the source MSTR object and initializes fields in the constructed MWS equivalent.
Parameters
| connectObj | MSTR session connect object. |
|---|---|
| moi | MWS object being constructed |
| woi | Source MSTR Web object |
Throws
| MWSException | |
| MWSException |
public static void PopulateRSDocumentInfo (MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi)
Retrieves RSDocument related information from the source MSTR object and initializes fields in the constructed MWS equivalent.
Parameters
| connectObj | MSTR session connect object. |
|---|---|
| moi | MWS object being constructed |
| woi | Source MSTR Web object |
Throws
| MWSException | |
| MWSException |
public static void PopulateReportInfo (MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi)
Retrieves Report related information from the source MSTR object and initializes fields in the constructed MWS equivalent.
Parameters
| connectObj | MSTR session connect object. |
|---|---|
| moi | MWS object being constructed |
| woi | Source MSTR Web object |
Throws
| MWSException | |
| MWSException |
public static MWSObjectInfo PopulateShortcutInfo (MWSConnection connectObj, MWSObjectInfo moi, WebObjectInfo woi, ArrayOfMWSObjectInfoPropertySetSpec aOfPropSetSpecs)
Retrieves shortcut related information from the source MSTR object and initializes fields in the constructed MWS equivalent.
Parameters
| connectObj | MSTR session connect object. |
|---|---|
| moi | MWS object being constructed |
| woi | Source MSTR Web object |
Throws
| MWSException | |
| MWSException |
public static String getFolderPath (MWSConnection connectObj, WebObjectInfo mstrObjectInfo)
Constructs the folderpath of the supplied object.
Parameters
| connectObj | Session connect object. |
|---|---|
| mstrObjectInfo | MSTR Web representation of object |
Returns
- String folder path.
Throws
| MWSException | |
| MWSException |