Package com.microstrategy.web.objects

Interface WebConnectionMapSource

public interface WebConnectionMapSource

Object used to retrieve WebConnectionMap objects from. Can itself be retrieved from WebObjectSource

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
WebConnectionMap	createConnectionMap(WebDBRole role, WebUserEntity user, WebProject project, WebLocaleObjectInfo locale, WebDBConnection connection, WebDBLogin login)	Return a new WebConnectionMap/WebLocalizedConnectionMap.
WebConnectionMap	get(WebDBRole role, WebUserEntity user, WebProject project)	Deprecated. use getMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo) to retrieve maps from Iserver.
WebConnectionMap[]	getAllConnectionMaps()	Return an array of WebConnectionMap/WebLocalizedConnectionMap objects.
java.util.List<WebConnectionMap>	getMatchingConnectionMaps(WebDBRole role, WebUserEntity user, WebProject project, WebLocaleObjectInfo locale)	Return a List of WebConnectionMap and WebLocalizedConnectionMap objects that contain all the specified role, user, project, and locale objects.
void	saveConnectionMaps(java.util.List<WebConnectionMap> connectionMaps)	Save connection maps to metadata.

Method Detail

get

@Deprecated
WebConnectionMap get(WebDBRole role,
                     WebUserEntity user,
                     WebProject project)
              throws WebObjectsException

Deprecated.

use getMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo) to retrieve maps from Iserver. use createConnectionMap(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo, WebDBConnection, WebDBLogin) to create new maps.

Return either existing WebConnectionMap or new WebLocalizedConnectionMap with role, user, and project set. If more than one map exists in the MD, the first map encountered is returned

Parameters:

role - WebDBRole specifying parameters used for the connection

user - WebUser specifying user/group which connection map will be applied to

project - WebProject specifying for which project connection map will be applied to

Returns:

WebConnectionMap with role, user, and project set

Throws:

WebObjectsException

getAllConnectionMaps

WebConnectionMap[] getAllConnectionMaps()
                                 throws WebObjectsException

Return an array of WebConnectionMap/WebLocalizedConnectionMap objects. Note that this method will only return user-generated objects (defaults are not returned).

Returns:

Array of WebConnectionMap objects containing all connetion maps on IServer

Throws:

WebObjectsException

getMatchingConnectionMaps

java.util.List<WebConnectionMap> getMatchingConnectionMaps(WebDBRole role,
                                                           WebUserEntity user,
                                                           WebProject project,
                                                           WebLocaleObjectInfo locale)
                                                    throws WebObjectsException

Return a List of WebConnectionMap and WebLocalizedConnectionMap objects that contain all the specified role, user, project, and locale objects. If no objects are specified, all map objects are returned. Returns an empty list if no map contains all the specified objects.

Parameters:

role - WebDBRole specifying parameters used for the connection

user - WebUser specifying user/group which connection map will be applied to

project - WebProject specifying for which project connection map will be applied to

locale - WebLocaleObjectInfo specifying which language/locale the user is connecting with. If any locale is specified, only WebLocalizedConnectionMap objects will be returned

Returns:

List of maps that match specified parameters

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.1

createConnectionMap

WebConnectionMap createConnectionMap(WebDBRole role,
                                     WebUserEntity user,
                                     WebProject project,
                                     WebLocaleObjectInfo locale,
                                     WebDBConnection connection,
                                     WebDBLogin login)
                              throws WebObjectsException

Return a new WebConnectionMap/WebLocalizedConnectionMap. This method does not check to see if a matching map already exists in MD. Use getMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo) to check for existence of map in MD.

Parameters:

role - WebDBRole specifying parameters used for the connection

user - WebUser specifying user/group which connection map will be applied to

project - WebProject specifying for which project connection map will be applied to

locale - WebLocaleObjectInfo specifying which language/locale the user is connecting with. Specify null if WebConnectionMap is desired

connection - WebDBConnection specifying connection parameters to used by IServer when connecting

login - WebDBLogin specifying credentials to be used by IServer when connecting

Returns:

new WebLocalizedConnectionMap

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.1

saveConnectionMaps

void saveConnectionMaps(java.util.List<WebConnectionMap> connectionMaps)
                 throws WebObjectsException

Save connection maps to metadata.

Parameters:

connectionMaps - List of connection map.

Throws:

WebObjectsException - throws exception.