Package com.microstrategy.web.objects
Interface WebConnectionMapSource
-
public interface WebConnectionMapSource
Object used to retrieveWebConnectionMap
objects from. Can itself be retrieved fromWebObjectSource
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description WebConnectionMap
createConnectionMap(WebDBRole role, WebUserEntity user, WebProject project, WebLocaleObjectInfo locale, WebDBConnection connection, WebDBLogin login)
Return a newWebConnectionMap
/WebLocalizedConnectionMap
.WebConnectionMap
get(WebDBRole role, WebUserEntity user, WebProject project)
Deprecated.usegetMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo)
to retrieve maps from Iserver.WebConnectionMap[]
getAllConnectionMaps()
Return an array ofWebConnectionMap
/WebLocalizedConnectionMap
objects.java.util.List<WebConnectionMap>
getMatchingConnectionMaps(WebDBRole role, WebUserEntity user, WebProject project, WebLocaleObjectInfo locale)
Return aList
ofWebConnectionMap
andWebLocalizedConnectionMap
objects that contain all the specified role, user, project, and locale objects.
-
-
-
Method Detail
-
get
WebConnectionMap get(WebDBRole role, WebUserEntity user, WebProject project) throws WebObjectsException
Deprecated.usegetMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo)
to retrieve maps from Iserver. usecreateConnectionMap(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo, WebDBConnection, WebDBLogin)
to create new maps.Return either existingWebConnectionMap
or newWebLocalizedConnectionMap
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 connectionuser
-WebUser
specifying user/group which connection map will be applied toproject
-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 ofWebConnectionMap
/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 aList
ofWebConnectionMap
andWebLocalizedConnectionMap
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 connectionuser
-WebUser
specifying user/group which connection map will be applied toproject
-WebProject
specifying for which project connection map will be applied tolocale
-WebLocaleObjectInfo
specifying which language/locale the user is connecting with. If any locale is specified, onlyWebLocalizedConnectionMap
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 newWebConnectionMap
/WebLocalizedConnectionMap
. This method does not check to see if a matching map already exists in MD. UsegetMatchingConnectionMaps(WebDBRole, WebUserEntity, WebProject, WebLocaleObjectInfo)
to check for existence of map in MD.- Parameters:
role
-WebDBRole
specifying parameters used for the connectionuser
-WebUser
specifying user/group which connection map will be applied toproject
-WebProject
specifying for which project connection map will be applied tolocale
-WebLocaleObjectInfo
specifying which language/locale the user is connecting with. Specifynull
ifWebConnectionMap
is desiredconnection
-WebDBConnection
specifying connection parameters to used by IServer when connectinglogin
-WebDBLogin
specifying credentials to be used by IServer when connecting- Returns:
- new
WebLocalizedConnectionMap
- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.1
-
-