public interface

WebConnectionMapSource

com.microstrategy.web.objects.WebConnectionMapSource

Class Overview

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

Summary

Public Methods
abstract WebConnectionMap createConnectionMap(WebDBRole role, WebUserEntity user, WebProject project, WebLocaleObjectInfo locale, WebDBConnection connection, WebDBLogin login)
Return a new WebConnectionMap/WebLocalizedConnectionMap.
abstract WebConnectionMap get(WebDBRole role, WebUserEntity user, WebProject project)
This method is deprecated. use getMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo) to retrieve maps from Iserver. use createConnectionMap(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo, WebDBConnection, WebDBLogin) to create new maps.
abstract WebConnectionMap[] getAllConnectionMaps()
Return an array of WebConnectionMap/WebLocalizedConnectionMap objects.
abstract 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.

Public Methods

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

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
Throws
WebObjectsException
WebObjectsException

public abstract WebConnectionMap get (WebDBRole role, WebUserEntity user, WebProject project)

This method is 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
Throws
WebObjectsException

public abstract WebConnectionMap[] getAllConnectionMaps ()

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

Returns
Throws
WebObjectsException

public abstract 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. 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
WebObjectsException