blackboard.platform.dataintegration.mapping
Interface DataIntegrationObjectMappingManager


public interface DataIntegrationObjectMappingManager

Manager for mapping data integration operations/objects from SIS to Learn.

Since:
Bb 9.1 SP6

Method Summary
 void deleteSISObject(java.lang.String sisObjectType, java.lang.String batchUid, DataIntegration integration)
          Delete the SIS object (of the specified type) having the specified batchUid in the specified data integration.
 void deleteSISObject(java.lang.String sisObjectType, java.lang.String batchUid, DataIntegration integration, blackboard.platform.dataintegration.mapping.BatchProcessor batchProcessor)
          Delete the SIS object (of the specified type) having the specified batchUid in the specified data integration.
 java.util.List<DataIntegrationLearnObjectType> getAllLearnObjectTypes()
          Returns all Learn Object Types supported by the system.
 java.util.List<DataIntegrationSISObjectType> getAllSISObjectTypes()
          Returns all SIS Object Types registered in the system.
 blackboard.platform.dataintegration.mapping.BatchProcessor getFullIntegrationBatchProcessor(DataIntegration integration)
          Get a BatchProcessor that will call deleteSISObject(String, String, DataIntegration) on any previously processed records in the specified integration that are not in the group of objects processed during the batch.
 DataIntegrationLearnObjectType getLearnObjectType(java.lang.String typeName)
          Returns the DataIntegrationLearnObjectType having the specified type name.
 blackboard.platform.dataintegration.mapping.BatchProcessor getNoOpBatchProcessor()
          Get a BatchProcessor that does nothing.
 blackboard.platform.dataintegration.mapping.BatchProcessor getSingleSISObjectTypeBatchProcessor(java.lang.String sisObjectType, DataIntegration integration)
          Get a BatchProcessor that will call deleteSISObject(String, String, DataIntegration) on any previously processed records of the specified type in the specified integration that are not in the group of objects processed during the batch.
 DataIntegrationSISObjectType getSisObjectType(java.lang.String typeName)
          Returns the DataIntegrationSISObjectType having the specified type name.
 DataIntegrationObjectMapping loadMappingById(Id id)
          Load a specific DataIntegrationObjectMapping
 java.util.List<DataIntegrationObjectMapping> loadMappingsForIntegration(Id diId)
          Loads all the mappings for the specified data integration and merges it with the default mappings for integrations of this type such that any LearnObjectTypes not covered by the existing integration will be handled by the default mappings.
 java.util.List<DataIntegrationObjectMapping> loadMappingsForIntegrationAndSISObjectType(Id diId, java.lang.String sisObjectType)
          Loads all mappings for a given data integration and merges it with the default mappings for integrations of this type such that any LearnObjectTypes not covered by the existing integration will be handled by the default mappings.
 void persistSISObject(java.lang.String sisObjectType, java.lang.Object sisObject, DataIntegration integration)
          Persist the specified SIS object (of the specified type) in the specified data integration.
 void persistSISObject(java.lang.String sisObjectType, java.lang.Object sisObject, DataIntegration integration, blackboard.platform.dataintegration.mapping.BatchProcessor batchProcessor)
          Persist the specified SIS object (of the specified type) in the specified data integration.
 void removeMapping(DataIntegrationObjectMapping mapping)
          Deletes a DataIntegrationObjectMapping
 void removeMappings(java.util.List<DataIntegrationObjectMapping> mappings)
          Delete a list of DataIntegrationObjectMapping objects.
 void saveMapping(DataIntegrationObjectMapping dom)
          Saves the DataIntegrationObjectMapping
 void saveMappings(java.util.List<DataIntegrationObjectMapping> doms)
          Saves a collection of DataIntegrationObjectMapping
 

Method Detail

removeMapping

void removeMapping(DataIntegrationObjectMapping mapping)
Deletes a DataIntegrationObjectMapping


removeMappings

void removeMappings(java.util.List<DataIntegrationObjectMapping> mappings)
Delete a list of DataIntegrationObjectMapping objects.


saveMapping

void saveMapping(DataIntegrationObjectMapping dom)
Saves the DataIntegrationObjectMapping

Parameters:
dom - DataIntegrationObjectMapping to persist/update.

saveMappings

void saveMappings(java.util.List<DataIntegrationObjectMapping> doms)
Saves a collection of DataIntegrationObjectMapping

Parameters:
doms - List of DataIntegrationObjectMapping to persist/update

loadMappingById

DataIntegrationObjectMapping loadMappingById(Id id)
                                             throws KeyNotFoundException
Load a specific DataIntegrationObjectMapping

Parameters:
id - Id of the mapping to load
Returns:
the mapping with the specified id.
Throws:
KeyNotFoundException - if no mapping exists with the specified Id.

loadMappingsForIntegration

java.util.List<DataIntegrationObjectMapping> loadMappingsForIntegration(Id diId)
Loads all the mappings for the specified data integration and merges it with the default mappings for integrations of this type such that any LearnObjectTypes not covered by the existing integration will be handled by the default mappings.

Parameters:
diId - Id of the data integration.
Returns:
All the mappings associated to the specified integration.

loadMappingsForIntegrationAndSISObjectType

java.util.List<DataIntegrationObjectMapping> loadMappingsForIntegrationAndSISObjectType(Id diId,
                                                                                        java.lang.String sisObjectType)
Loads all mappings for a given data integration and merges it with the default mappings for integrations of this type such that any LearnObjectTypes not covered by the existing integration will be handled by the default mappings. It then returns results filtered for the specified SIS object.

Parameters:
diId - Id of the data integration.
sisObjectType - type of the SIS object
Returns:
All mappings for the data integration for the specified SIS object.

getLearnObjectType

DataIntegrationLearnObjectType getLearnObjectType(java.lang.String typeName)
Returns the DataIntegrationLearnObjectType having the specified type name.

Parameters:
typeName - the name of the Learn Object Type
Returns:
a DataIntegrationLearnObjectType object or null if none exists with the specified type.

getAllLearnObjectTypes

java.util.List<DataIntegrationLearnObjectType> getAllLearnObjectTypes()
Returns all Learn Object Types supported by the system.


getSisObjectType

DataIntegrationSISObjectType getSisObjectType(java.lang.String typeName)
Returns the DataIntegrationSISObjectType having the specified type name.

Parameters:
typeName - the type name of the SIS Object Type
Returns:
a DataIntegrationSISObjectType object or null if none exists with the specified type.

getAllSISObjectTypes

java.util.List<DataIntegrationSISObjectType> getAllSISObjectTypes()
Returns all SIS Object Types registered in the system.


getNoOpBatchProcessor

blackboard.platform.dataintegration.mapping.BatchProcessor getNoOpBatchProcessor()
Get a BatchProcessor that does nothing.


getSingleSISObjectTypeBatchProcessor

blackboard.platform.dataintegration.mapping.BatchProcessor getSingleSISObjectTypeBatchProcessor(java.lang.String sisObjectType,
                                                                                                DataIntegration integration)
Get a BatchProcessor that will call deleteSISObject(String, String, DataIntegration) on any previously processed records of the specified type in the specified integration that are not in the group of objects processed during the batch.

Parameters:
sisObjectType - The single type of object being processed.
integration - The DataIntegration this batch is happening for.
Returns:
A Batch Processor.

getFullIntegrationBatchProcessor

blackboard.platform.dataintegration.mapping.BatchProcessor getFullIntegrationBatchProcessor(DataIntegration integration)
Get a BatchProcessor that will call deleteSISObject(String, String, DataIntegration) on any previously processed records in the specified integration that are not in the group of objects processed during the batch.

Parameters:
integration - The DataIntegration this batch is happening for.
Returns:
A Batch Processor

persistSISObject

void persistSISObject(java.lang.String sisObjectType,
                      java.lang.Object sisObject,
                      DataIntegration integration)
                      throws java.lang.Exception
Persist the specified SIS object (of the specified type) in the specified data integration.

This is equivalent to calling persistSISObject(String, Object, DataIntegration, BatchProcessor) with the BatchProcessor returned by getNoOpBatchProcessor().

Parameters:
sisObjectType - the type name of the SIS Object Type.
sisObject - the SIS object.
integration - the DataIntegration this object is being persisted for.
Throws:
java.lang.Exception - if an unrecoverable error occurs during persisting.

persistSISObject

void persistSISObject(java.lang.String sisObjectType,
                      java.lang.Object sisObject,
                      DataIntegration integration,
                      blackboard.platform.dataintegration.mapping.BatchProcessor batchProcessor)
                      throws java.lang.Exception
Persist the specified SIS object (of the specified type) in the specified data integration.

Parameters:
sisObjectType - The type name of the SIS Object Type.
sisObject - The SIS object.
integration - The DataIntegration this object is being persisted for.
batchProcessor - The BatchProcessor for the current batch of SIS objects.
Throws:
java.lang.Exception - If an unrecoverable error occurs during persisting.

deleteSISObject

void deleteSISObject(java.lang.String sisObjectType,
                     java.lang.String batchUid,
                     DataIntegration integration)
                     throws java.lang.Exception
Delete the SIS object (of the specified type) having the specified batchUid in the specified data integration.

This is equivalent to calling deleteSISObject(String, String, DataIntegration, BatchProcessor) with the BatchProcessor returned by getNoOpBatchProcessor().

Parameters:
sisObjectType - the type name of the SIS Object Type.
batchUid - the unique id of the object to delete.
integration - the DataIntegration this object is being deleted from.
Throws:
java.lang.Exception - if an unrecoverable error occurs during deletion.

deleteSISObject

void deleteSISObject(java.lang.String sisObjectType,
                     java.lang.String batchUid,
                     DataIntegration integration,
                     blackboard.platform.dataintegration.mapping.BatchProcessor batchProcessor)
                     throws java.lang.Exception
Delete the SIS object (of the specified type) having the specified batchUid in the specified data integration.

Parameters:
sisObjectType - the type name of the SIS Object Type.
batchUid - the unique id of the object to delete.
integration - the DataIntegration this object is being deleted from.
batchProcessor - The BatchProcessor for the current batch of SIS objects.
Throws:
java.lang.Exception - if an unrecoverable error occurs during deletion.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.