com.semarchy.mdm.client
Interface IMDMConnection

All Superinterfaces:
Serializable

public interface IMDMConnection
extends Serializable

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.

Author:
sarod
See Also:
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

getPlatformVersion

String getPlatformVersion()
Returns the version of the remote Convergence For MDM instance.

Returns:

getPlatformBuildID

String getPlatformBuildID()
Returns the BuildID of the remote Convergence For MDM instance.

Returns:

getUserName

String getUserName()
Returns the name of the authenticated user.

Returns:

getUserRoles

Set<String> getUserRoles()
Returns the Set of roles. The Convergence MDM roles for authenticated user

Returns:

getPlatformStatus

PlatformStatus getPlatformStatus()
Return the PlatformStatus of the instance. An instance that is not in PlatformStatus.PLATFORM_READY will not be able to serve any request.

Returns:

createDataEditionConnection

IDataEditionConnection createDataEditionConnection(DataEditionID pDataEditionID)
                                                   throws NoSuchDataEditionException
Opens a connection to a Convergence for MDM Data Edition.

Parameters:
pDataEditionID -
Returns:
Throws:
NoSuchDataEditionException

getDataEditions

List<DataEditionID> getDataEditions(String pDataLocationName,
                                    Long pDataBranchID,
                                    Long pDataEditionID)
Returns the list of DataEditionID matching the provided not null parameters. This is a shortcut to getDataEditions(String, Long, Long) on getDataLocationService()

Parameters:
pDataLocationName - the Data Location Name to match or null to skip filtering on data location name
pDataBranchID - the DataBranchID to match or null to skip filtering on DataBranchID
pDataEditionID - the DataEditionID to match or null to skip filtering on DataEditionID
Returns:

getDataEditionInfos

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()

Parameters:
pDataLocationName -
pDataBranchID -
pDataEditionID -
Returns:

getPurgeService

IPurgeService getPurgeService()
Return the purge service instance of the remote Convergence For MDM instance.

Returns:

getDataLocationService

IDataLocationAdminService getDataLocationService()
Return the Data Location Admin service of the remote Convergence For MDM instance.

Returns:

getDataEditionInfoOpenedAsOfDate

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.

Parameters:
pDataLocationName -
pDataBranchID -
pReferenceDate -
Returns:


Copyright © 2015. All Rights Reserved.