Package com.microstrategy.web.objects

Interface WebConnectionMap

All Known Subinterfaces:

WebLocalizedConnectionMap

public interface WebConnectionMap

A Connection Map is an association of one WebDBLogin, one WebDBConnection, one WebDBRole, one WebUser, and one WebProject. Each connection map is uniquely identified by its role, user, and project.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes the WebConnectionMap from the IServer.
WebDBConnection	getConnection()	Return the WebDBConnection object associated with this connection map
WebDBLogin	getLogin()	Return the WebDBLogin object associated with this Connection Map
WebProject	getProject()	Returns the WebProject object associated with this connection map
WebDBRole	getRole()	Returns the associated WebDBRole object
WebUserEntity	getUser()	Returns the WebUserEntity associated with this connection map
boolean	isInMD()	Specifies whether this connection map (identified by role, project, user) exists in metadata
void	save()	Saves all changes made to the WebConnectionMap.
void	setConnection(WebDBConnection connection)	Sets the WebDBConnection object assciated with this connection map
void	setLogin(WebDBLogin login)	Sets the WebDBLogin object by object

Method Detail

getLogin

WebDBLogin getLogin()

Return the WebDBLogin object associated with this Connection Map

Returns:

Unpopulated WebDBLogin object

setLogin

void setLogin(WebDBLogin login)

Sets the WebDBLogin object by object

Parameters:

login - WebDBLogin object to be associated with this Connection Map

getConnection

WebDBConnection getConnection()

Return the WebDBConnection object associated with this connection map

Returns:

Unpopulated WebDBConnection object

setConnection

void setConnection(WebDBConnection connection)

Sets the WebDBConnection object assciated with this connection map

Parameters:

connection - WebDBConnection Object to be associated

getRole

WebDBRole getRole()

Returns the associated WebDBRole object

Returns:

Unpopulated WebDBRole object

getUser

WebUserEntity getUser()

Returns the WebUserEntity associated with this connection map

Returns:

Unpopulated WebUserEntity object

getProject

WebProject getProject()

Returns the WebProject object associated with this connection map

Returns:

Unpopulated WebProject object

save

void save()
   throws WebObjectsException

Saves all changes made to the WebConnectionMap. This will overwrite any connection maps on the IServer with the same project, user, and DBRole

Throws:

WebObjectsException

delete

void delete()
     throws WebObjectsException

Deletes the WebConnectionMap from the IServer.

Throws:

WebObjectsException

isInMD

boolean isInMD()

Specifies whether this connection map (identified by role, project, user) exists in metadata

Returns:

boolean expressing whether the connection map exists in metadata