org.finra.herd.service

Interface RelationalTableRegistrationService

All Known Implementing Classes:

RelationalTableRegistrationServiceImpl

public interface RelationalTableRegistrationService

The relational table registration service.

Method Summary

Modifier and Type	Method and Description
BusinessObjectData	createRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition) Creates a new relational table registration.
RelationalTableRegistrationDeleteResponse	deleteRelationalTableRegistration(BusinessObjectFormatKey businessObjectFormatKey) Deletes a relational table registration.
List<BusinessObjectDataStorageUnitKey>	getRelationalTableRegistrationsForSchemaUpdate() Returns latest versions of all relational tables registered in the system.
BusinessObjectData	processRelationalTableRegistrationForSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey) Updates relational table schema, if changes are detected, for an already existing relational table registration.

Method Detail

createRelationalTableRegistration

BusinessObjectData createRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest,
                                                     Boolean appendToExistingBusinessObjectDefinition)

Creates a new relational table registration. The relation table registration includes creation of the following entities:

• a business object definition
• a business object format with schema extracted from the specified relational table in the specified storage of RELATIONAL storage platform type
• a business object data
• a storage unit that links together the business object data with the storage

Parameters:

relationalTableRegistrationCreateRequest - the relational table registration create request

appendToExistingBusinessObjectDefinition - boolean flag that determines if the format should be appended to an existing business object definition

Returns:

the information for the newly created business object data

deleteRelationalTableRegistration

RelationalTableRegistrationDeleteResponse deleteRelationalTableRegistration(BusinessObjectFormatKey businessObjectFormatKey)

Deletes a relational table registration.

Parameters:

businessObjectFormatKey - the business object format key

Returns:

the relational table registration delete response

getRelationalTableRegistrationsForSchemaUpdate

List<BusinessObjectDataStorageUnitKey> getRelationalTableRegistrationsForSchemaUpdate()

Returns latest versions of all relational tables registered in the system.

Returns:

the list of relational table registrations

processRelationalTableRegistrationForSchemaUpdate

BusinessObjectData processRelationalTableRegistrationForSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey)

Updates relational table schema, if changes are detected, for an already existing relational table registration. The relation table schema update includes creation of the following entities:

• a new version of the business object format with updated schema as extracted from the specified relational table in the specified storage of RELATIONAL storage platform type
• a business object data that is associated with the new business object format version
• a storage unit that links together the newly created business object data with the storage

Parameters:

storageUnitKey - the storage unit key for relational table registration

Returns:

the information for the newly created business object data, if schema was updated; null otherwise