blackboard.platform.dataintegration
Interface DataIntegrationManager

public interface DataIntegrationManager

Manager for data integrations.

Since:

Bb 9.1 SP6

Method Summary

void	deleteDataIntegrationById(Id id) Delete the DataIntegration of the given Id
java.util.List<DataIntegrationDocument>	getDocumentation() Returns all of the available Data Integration documentation.
DataIntegration.IntegrationState	getIntegrationState(DataIntegration integration) Get the state of the DataIntegration, taking into account whether the integration Building Block is enabled or disabled.
java.util.List<DataIntegration>	loadAllDataIntegrations() Load all DataIntegrations installed on the system.
DataIntegration	loadByGuid(java.lang.String guid) Load a DataIntegration by its GUID.
DataIntegration	loadById(Id dataIntegrationId) Load a DataIntegration by its Id
java.util.List<DataIntegration>	loadDataIntegrationsByType(java.lang.String typeHandle) Load all DataIntegrations of the given type.
void	saveDataIntegration(DataIntegration di) Save a DataIntegration.

Method Detail

saveDataIntegration

void saveDataIntegration(DataIntegration di)

Save a DataIntegration.

Parameters:

di - The data integration to save.

loadDataIntegrationsByType

java.util.List<DataIntegration> loadDataIntegrationsByType(java.lang.String typeHandle)

Load all DataIntegrations of the given type.

Parameters:

typeHandle - The type of integration.

Returns:

A List of DataIntegrations of the given type.

loadAllDataIntegrations

java.util.List<DataIntegration> loadAllDataIntegrations()

Load all DataIntegrations installed on the system.

Returns:

A list of all DataIntegrations.

loadById

DataIntegration loadById(Id dataIntegrationId)
                         throws KeyNotFoundException,
                                PersistenceRuntimeException

Load a DataIntegration by its Id

Parameters:

dataIntegrationId - The Id of the DataIntegration to load.

Returns:

The data integration

Throws:

KeyNotFoundException - if no such data integration exists.

PersistenceRuntimeException

loadByGuid

DataIntegration loadByGuid(java.lang.String guid)
                           throws KeyNotFoundException

Load a DataIntegration by its GUID.

Parameters:

guid - The GUID of the data integration.

Returns:

The data integration

Throws:

KeyNotFoundException - if no such data integration exists.

deleteDataIntegrationById

void deleteDataIntegrationById(Id id)

Delete the DataIntegration of the given Id

Parameters:

id - The id of the data integration to delete.

getIntegrationState

DataIntegration.IntegrationState getIntegrationState(DataIntegration integration)

Get the state of the DataIntegration, taking into account whether the integration Building Block is enabled or disabled.

Parameters:

integration - The integration whose state should be checked

Returns:

The state of the integration.

getDocumentation

java.util.List<DataIntegrationDocument> getDocumentation()

Returns all of the available Data Integration documentation. This includes built-in documentation, and documentation added by data integration building blocks.

Returns:

a List of DataIntegrationDocument objects.