Package com.microstrategy.web.objects
Interface WebConnectionMap
-
- All Known Subinterfaces:
WebLocalizedConnectionMap
public interface WebConnectionMap
A Connection Map is an association of oneWebDBLogin
, oneWebDBConnection
, oneWebDBRole
, oneWebUser
, and oneWebProject
. Each connection map is uniquely identified by its role, user, and project.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
delete()
Deletes theWebConnectionMap
from the IServer.WebDBConnection
getConnection()
Return theWebDBConnection
object associated with this connection mapWebDBLogin
getLogin()
Return theWebDBLogin
object associated with this Connection MapWebProject
getProject()
Returns theWebProject
object associated with this connection mapWebDBRole
getRole()
Returns the associatedWebDBRole
objectWebUserEntity
getUser()
Returns theWebUserEntity
associated with this connection mapboolean
isInMD()
Specifies whether this connection map (identified by role, project, user) exists in metadatavoid
save()
Saves all changes made to theWebConnectionMap
.void
setConnection(WebDBConnection connection)
Sets theWebDBConnection
object assciated with this connection mapvoid
setLogin(WebDBLogin login)
Sets theWebDBLogin
object by object
-
-
-
Method Detail
-
getLogin
WebDBLogin getLogin()
Return theWebDBLogin
object associated with this Connection Map- Returns:
- Unpopulated
WebDBLogin
object
-
setLogin
void setLogin(WebDBLogin login)
Sets theWebDBLogin
object by object- Parameters:
login
-WebDBLogin
object to be associated with this Connection Map
-
getConnection
WebDBConnection getConnection()
Return theWebDBConnection
object associated with this connection map- Returns:
- Unpopulated
WebDBConnection
object
-
setConnection
void setConnection(WebDBConnection connection)
Sets theWebDBConnection
object assciated with this connection map- Parameters:
connection
-WebDBConnection
Object to be associated
-
getRole
WebDBRole getRole()
Returns the associatedWebDBRole
object- Returns:
- Unpopulated
WebDBRole
object
-
getUser
WebUserEntity getUser()
Returns theWebUserEntity
associated with this connection map- Returns:
- Unpopulated
WebUserEntity
object
-
getProject
WebProject getProject()
Returns theWebProject
object associated with this connection map- Returns:
- Unpopulated
WebProject
object
-
save
void save() throws WebObjectsException
Saves all changes made to theWebConnectionMap
. This will overwrite any connection maps on the IServer with the same project, user, and DBRole- Throws:
WebObjectsException
-
delete
void delete() throws WebObjectsException
Deletes theWebConnectionMap
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
-
-