Package com.orchestranetworks.addon.dex.common

Provides the classes and interfaces used to supply a context for integrating {addon.label} services.

Creating a context for the data transfer service

1. Define the {addon.label} context:

           DataExchangeServiceContext dexServiceContext = DataExchangeServiceContextFactory.getInstance().getDataExchangeServiceContext(serviceContext);
   

2. Use the {addon.label} context in data transfer:

           TransferConfigurationSpec configSpec = new TransferConfigurationSpec(dexServiceContext);
   

Creating and getting a common application for the API, which automatically generates all mapping for the Excel/CSV Import/Export services

1. Create an instance of CommonApplication by the logical name declared in the Application table in the {addon.label} dataset and application type:

           CommonApplication commonApplication = CommonApplicationMappingFactory.getInstance().createCommonApplication(logicalName, ApplicationType.CSV);
   

2. Get an instance of CommonApplication by the universal name declared in the Application table in the {addon.label} dataset and application type:

           CommonApplication commonApplication = CommonApplicationMappingFactory.getInstance().getCommonApplication(repository, universalName, ApplicationType.CSV);
   

3. Get an instance of CommonApplication for an EBX® application:

           CommonApplication ebxCommonApplication = CommonApplicationMappingFactory.getInstance().getEBXCommonApplication(currentDataset, locale);
   

Getting a PrimaryKey set that identifies records in the Application interface preference table located in the {addon.label} dataset, which is used to export the selected records in the Application interface preference table and the related data from other tables to an XML file.

1. To get a PrimaryKey set by the specified codes declared in the Application interface preference table in {addon.label} dataset:

           
           Set<PrimaryKey> primaryKeys=ApplicationInterfaceConfigurationFactory.getInstance().getPrimaryKeysByCode(repository, codes);
   

2. To get a set of PrimaryKey by the specified names declared in the Application interface preference table in {addon.label} dataset:

           
           Set<PrimaryKey> primaryKeys=ApplicationInterfaceConfigurationFactory.getInstance().getPrimaryKeysByName(repository, names)
   

Interface Summary

Interface	Description
DataExchangeServiceContext	Provides the necessary context for integrating {addon.label} services.
EBXRecordPrimaryKey	Specifies the primary key of an EBX® record.
RecordPrimaryKey	Specifies primary key of a record.

Class Summary

Class	Description
ApplicationInterfaceConfigurationFactory	Provides the methods to get a PrimaryKey set that identifies records in the Application interface preference table located in the {addon.label} dataset.
CommonApplicationMappingFactory	Provides the methods to get a CommonApplication.
DataExchangeServiceContextFactory	Creates instances of DataExchangeServiceContext.