public class

MWSEnumHelper

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

Class Overview

MWSEnumHelper provides public static interfaces that convert MWS (MSTR Web Services) enum values to/from the WU(Web Universal) equivalents.

Summary

Public Constructors
MWSEnumHelper()
Public Methods
static EnumMWSElementSourceFlags convertStrArrayToElementSourceFlags(String[] eFlags)
Translates a String Array object input from the client into an EnumMWSElementSourceFlags object.
static EnumMWSExecutionFlags convertStrArrayToExecutionFlags(String[] eFlags)
Translates a String Array object input from the client into an EnumMWSExecutionFlags object.
static EnumMWSSearchFlags convertStrArrayToSearchFlags(String[] eFlags)
static Set<Integer> getFullUserPrivsSet(MWSWSDLVersion clientWSDLVersion)
static int mapAccRightsFromMWSToWU(EnumMWSAccessRights mwsRights)
Maps an EnumMWSAccessRights value to its EnumDSSXMLAccessRightFlags equivalent, bit ORing when necessary.
static EnumMWSAccessRights mapAccRightsFromWUToMWS(int wuRights)
Maps an EnumDSSXMLAccessRightFlags value to its EnumMWSAccessRights equivalent, bit ORing when necessary.
static String[] mapAccRightsFromWUToMWS2(int wuRights)
Maps an EnumDSSXMLAccessRightFlags value to its EnumMWSAccessRights equivalent, bit ORing when necessary.
static EnumMWSAttributeLockType mapAttributeLockTypeFromWUToMWS(int wuLockType)
Translates an EnumDSSXMLAttributeLockType object into a EnumMWSAttributeLockType object.
static EnumMWSDataType mapDataTypeFromWUToMWS(int wuDataType)
Translates an EnumDSSXMLDataType object into a EnumMWSDataType object.
static int mapFolderTypeFromMWSToWU(EnumMWSProjectFolder eVal)
static EnumMWSGraphType mapGraphTypeFromWUToMWS(int wuGraphType)
Maps an EnumDSSXMLMajorGraphTypes value to its EnumMWSGraphType equivalent.
static EnumMWSHistoryMessageStatus mapHistMsgStatusFromWUToMWS(int wuStatus)
Maps an EnumDSSXMLMessageStatus value to its EnumMWSHistoryMessageStatus equivalent, bit ORing when necessary.
static EnumMWSHistoryRequestStatus mapHistReqStatusFromWUToMWS(int wuStatus)
Maps an EnumDSSXMLStatus value to its EnumMWSHistoryRequestStatus equivalent.
static int mapObjTypeFromMWSToWU(EnumMWSObjectType mwsType)
Maps an EnumMWSObjectType value to its EnumDSSXMLObjectTypes equivalent.
static EnumMWSObjectType mapObjTypeFromWUToMWS(int wuType, int wuSubtype)
Maps an EnumDSSXMLObjectTypes value to its EnumMWSObjectType equivalent.
static int mapSrchFlagsFromMWSToWU(EnumMWSSearchFlags mwsFlags)
Maps an EnumMWSSearchFlags value to the EnumDSSXMLSearchFlags equivalent, bit ORing when necessary.
static int mapSubTypeFromMWSToWU(EnumMWSObjSubType mwsSubType)
Maps an EnumMWSObjSubType value to its EnumDSSXMLObjectSubTypes equivalent.
static EnumMWSObjSubType mapSubTypeFromWUToMWS(int wuSubType, MWSWSDLVersion ClientVersion)
Maps an EnumDSSXMLObjectSubTypes value to its EnumMWSObjSubType equivalent.
static Set<MWSUserPrivilege> mapUserPrivTypesFromWUToMWS(Set<Integer> userPrivTypes, MWSWSDLVersion clientWSDLVersion)
static EnumMWSViewMedia mapViewMediaFromWUToMWS(int wuModes)
Maps an EnumDSSXMLViewMedia value to its EnumMWSViewMedia equivalent, bit ORing when necessary.
static String[] mapViewMediaFromWUToMWS2(int wuModes)
Maps an EnumDSSXMLViewMedia value to its EnumMWSViewMedia string array equivalent, bit ORing when necessary.
static EnumMWSVisualizationScope mapVizScopeFromWUToMWS(int wuScope)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSEnumHelper ()

Public Methods

public static EnumMWSElementSourceFlags convertStrArrayToElementSourceFlags (String[] eFlags)

Translates a String Array object input from the client into an EnumMWSElementSourceFlags object.

Parameters
eFlags String Array input from client
Returns
  • EnumMWSElementSourceFlags WS-U execution flags enum

public static EnumMWSExecutionFlags convertStrArrayToExecutionFlags (String[] eFlags)

Translates a String Array object input from the client into an EnumMWSExecutionFlags object.

Parameters
eFlags String Array input from client
Returns
  • EnumMWSExecutionFlags WS-U execution flags enum

public static EnumMWSSearchFlags convertStrArrayToSearchFlags (String[] eFlags)

public static Set<Integer> getFullUserPrivsSet (MWSWSDLVersion clientWSDLVersion)

public static int mapAccRightsFromMWSToWU (EnumMWSAccessRights mwsRights)

Maps an EnumMWSAccessRights value to its EnumDSSXMLAccessRightFlags equivalent, bit ORing when necessary.

Parameters
mwsRights The EnumMWSAccessRights value to translate.
Returns
  • integer EnumDSSXMLAccessRightFlags value

public static EnumMWSAccessRights mapAccRightsFromWUToMWS (int wuRights)

Maps an EnumDSSXMLAccessRightFlags value to its EnumMWSAccessRights equivalent, bit ORing when necessary.

Parameters
wuRights The EnumDSSXMLAccessRightFlags value to convert.
Returns
  • The converted EnumMWSAccessRights value.

public static String[] mapAccRightsFromWUToMWS2 (int wuRights)

Maps an EnumDSSXMLAccessRightFlags value to its EnumMWSAccessRights equivalent, bit ORing when necessary.

Parameters
wuRights The EnumDSSXMLAccessRightFlags value to convert.
Returns
  • The converted EnumMWSAccessRights value.

public static EnumMWSAttributeLockType mapAttributeLockTypeFromWUToMWS (int wuLockType)

Translates an EnumDSSXMLAttributeLockType object into a EnumMWSAttributeLockType object.

Parameters
wuLockType WU Attribute lock type value
Returns
  • MWS lock type enum

public static EnumMWSDataType mapDataTypeFromWUToMWS (int wuDataType)

Translates an EnumDSSXMLDataType object into a EnumMWSDataType object. This is currently used only for attribute form types, so the mapping is limited to the few (4) EnumMWSDataType types.

Parameters
wuDataType WebObject data type
Returns
  • MWS form data type

public static int mapFolderTypeFromMWSToWU (EnumMWSProjectFolder eVal)

public static EnumMWSGraphType mapGraphTypeFromWUToMWS (int wuGraphType)

Maps an EnumDSSXMLMajorGraphTypes value to its EnumMWSGraphType equivalent.

Parameters
wuGraphType The EnumDSSXMLMajorGraphTypes value to convert.
Returns
  • The returned EnumMWSGraphType value.

public static EnumMWSHistoryMessageStatus mapHistMsgStatusFromWUToMWS (int wuStatus)

Maps an EnumDSSXMLMessageStatus value to its EnumMWSHistoryMessageStatus equivalent, bit ORing when necessary.

Parameters
wuStatus The EnumDSSXMLMessageStatus value to convert.
Returns
  • The converted EnumMWSHistoryMessageStatus value.

public static EnumMWSHistoryRequestStatus mapHistReqStatusFromWUToMWS (int wuStatus)

Maps an EnumDSSXMLStatus value to its EnumMWSHistoryRequestStatus equivalent.

Parameters
wuStatus The EnumDSSXMLStatus value to convert.
Returns
  • The converted EnumMWSHistoryRequestStatus value.

public static int mapObjTypeFromMWSToWU (EnumMWSObjectType mwsType)

Maps an EnumMWSObjectType value to its EnumDSSXMLObjectTypes equivalent.

Parameters
mwsType The EnumMWSObjectType to convert.
Returns
  • The converted EnumDSSXMLObjectTypes value.

public static EnumMWSObjectType mapObjTypeFromWUToMWS (int wuType, int wuSubtype)

Maps an EnumDSSXMLObjectTypes value to its EnumMWSObjectType equivalent.

Parameters
wuType The EnumDSSXMLObjectTypes value to convert.
wuSubtype An EnumDSSXMLObjectSubTypes value used for CustomGroup detection.
Returns
  • The converted EnumMWSObjectType value.

public static int mapSrchFlagsFromMWSToWU (EnumMWSSearchFlags mwsFlags)

Maps an EnumMWSSearchFlags value to the EnumDSSXMLSearchFlags equivalent, bit ORing when necessary.

Parameters
mwsFlags The combined EnumMWSSearchFlags value
Returns
  • The combined EnumDSSXMLSearchFlags value

public static int mapSubTypeFromMWSToWU (EnumMWSObjSubType mwsSubType)

Maps an EnumMWSObjSubType value to its EnumDSSXMLObjectSubTypes equivalent.

Parameters
mwsSubType The EnumMWSObjSubType to convert.
Returns
  • The converted EnumDSSXMLObjectSubTypes value.

public static EnumMWSObjSubType mapSubTypeFromWUToMWS (int wuSubType, MWSWSDLVersion ClientVersion)

Maps an EnumDSSXMLObjectSubTypes value to its EnumMWSObjSubType equivalent.

Parameters
wuSubType The EnumDSSXMLObjectSubTypes value to convert.
Returns
  • The returned EnumMWSObjSubType value.

public static Set<MWSUserPrivilege> mapUserPrivTypesFromWUToMWS (Set<Integer> userPrivTypes, MWSWSDLVersion clientWSDLVersion)

public static EnumMWSViewMedia mapViewMediaFromWUToMWS (int wuModes)

Maps an EnumDSSXMLViewMedia value to its EnumMWSViewMedia equivalent, bit ORing when necessary.

Parameters
wuModes The EnumDSSXMLViewMedia value to convert.
Returns
  • The converted EnumMWSViewMedia value.

public static String[] mapViewMediaFromWUToMWS2 (int wuModes)

Maps an EnumDSSXMLViewMedia value to its EnumMWSViewMedia string array equivalent, bit ORing when necessary.

Parameters
wuModes The RS Doc View mode value to convert.
Returns
  • The converted EnumMWSViewMedia in string array form value.

public static EnumMWSVisualizationScope mapVizScopeFromWUToMWS (int wuScope)