|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMDMConnection
This class represents a connection to a Convergence For MDM instance authenticated with some credentials. It's the entry point that gives access to all services of the Convergence For MDM Client API.
Creating a connection have some cost so it's better to keep it for the lifetime of a given user session. This class is Serializable it can easily be added to a HttpSession for instance.
MDMConnectionFactory
Method Summary | |
---|---|
IDataEditionConnection |
createDataEditionConnection(DataEditionID pDataEditionID)
Opens a connection to a Convergence for MDM Data Edition. |
DataEditionInfo |
getDataEditionInfoOpenedAsOfDate(String pDataLocationName,
long pDataBranchID,
Date pReferenceDate)
* Retrieve DataEditionInfo for a given data branch on a given data location and that was open at the given date. |
List<DataEditionInfo> |
getDataEditionInfos(String pDataLocationName,
Long pDataBranchID,
Long pDataEditionID)
Returns the list of DataEditionInfo matching the provided not null
This is a shortcut to getDataEditionInfos(String, Long, Long) on getDataLocationService() |
List<DataEditionID> |
getDataEditions(String pDataLocationName,
Long pDataBranchID,
Long pDataEditionID)
Returns the list of DataEditionID matching the provided not null
parameters. |
IDataLocationAdminService |
getDataLocationService()
Return the Data Location Admin service of the remote Convergence For MDM instance. |
String |
getPlatformBuildID()
Returns the BuildID of the remote Convergence For MDM instance. |
PlatformStatus |
getPlatformStatus()
Return the PlatformStatus of the instance. |
String |
getPlatformVersion()
Returns the version of the remote Convergence For MDM instance. |
IPurgeService |
getPurgeService()
Return the purge service instance of the remote Convergence For MDM instance. |
String |
getUserName()
Returns the name of the authenticated user. |
Set<String> |
getUserRoles()
Returns the Set of roles. |
Method Detail |
---|
String getPlatformVersion()
String getPlatformBuildID()
String getUserName()
Set<String> getUserRoles()
PlatformStatus getPlatformStatus()
PlatformStatus
of the instance. An instance that is
not in PlatformStatus.PLATFORM_READY
will not be able to serve
any request.
IDataEditionConnection createDataEditionConnection(DataEditionID pDataEditionID) throws NoSuchDataEditionException
pDataEditionID
-
NoSuchDataEditionException
List<DataEditionID> getDataEditions(String pDataLocationName, Long pDataBranchID, Long pDataEditionID)
DataEditionID
matching the provided not null
parameters.
This is a shortcut to getDataEditions(String, Long, Long)
on getDataLocationService()
pDataLocationName
- the Data Location Name to match or null to skip filtering on
data location namepDataBranchID
- the DataBranchID to match or null to skip filtering on
DataBranchIDpDataEditionID
- the DataEditionID to match or null to skip filtering on
DataEditionID
List<DataEditionInfo> getDataEditionInfos(String pDataLocationName, Long pDataBranchID, Long pDataEditionID)
DataEditionInfo
matching the provided not null
This is a shortcut to getDataEditionInfos(String, Long, Long)
on getDataLocationService()
pDataLocationName
- pDataBranchID
- pDataEditionID
-
IPurgeService getPurgeService()
IDataLocationAdminService getDataLocationService()
DataEditionInfo getDataEditionInfoOpenedAsOfDate(String pDataLocationName, long pDataBranchID, Date pReferenceDate)
DataEditionInfo
for a given data branch on a given data location and that was open at the given date.
pDataLocationName
- pDataBranchID
- pReferenceDate
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |