org.finra.herd.service

Interface RelationalTableRegistrationHelperService

All Known Implementing Classes:

RelationalTableRegistrationHelperServiceImpl

public interface RelationalTableRegistrationHelperService

The helper service class for the relational table registration service.

Method Summary

Modifier and Type	Method and Description
RelationalStorageAttributesDto	prepareForRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition) Prepares for relational table registration by validating database entities per specified relational table registration create request.
RelationalTableRegistrationDto	prepareForRelationalTableSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey) Prepares for relational table schema update by validating database entities per specified storage unit key.
BusinessObjectData	registerRelationalTable(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, List<SchemaColumn> schemaColumns, Boolean appendToExistingBusinessObjectDefinition) Creates a new relational table registration.
List<SchemaColumn>	retrieveRelationalTableColumns(RelationalStorageAttributesDto relationalStorageAttributesDto, String relationalSchemaName, String relationalTableName) Retrieves a list of actual schema columns for the specified relational table.
BusinessObjectData	updateRelationalTableSchema(RelationalTableRegistrationDto relationalTableRegistrationDto, List<SchemaColumn> schemaColumns) Updates relational table schema for an already existing relational table registration.
void	validateAndTrimRelationalTableRegistrationCreateRequest(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest) Validates a relational table registration create request.

Method Detail

prepareForRelationalTableRegistration

RelationalStorageAttributesDto prepareForRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest,
                                                                     Boolean appendToExistingBusinessObjectDefinition)

Prepares for relational table registration by validating database entities per specified relational table registration create request. This method returns storage attributes required to perform relation table registration.

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 relational storage attributes DTO

prepareForRelationalTableSchemaUpdate

RelationalTableRegistrationDto prepareForRelationalTableSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey)

Prepares for relational table schema update by validating database entities per specified storage unit key. This method returns a relational table registration DTO which contains attributes required to retrieve the current relation table schema.

Parameters:

storageUnitKey - the storage unit key for the relational table registration

Returns:

the relational table registration DTO

registerRelationalTable

BusinessObjectData registerRelationalTable(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest,
                                           List<SchemaColumn> schemaColumns,
                                           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 the specified schema columns
• a business object data
• a storage unit that links together the business object data with the storage specified in the create request

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

retrieveRelationalTableColumns

List<SchemaColumn> retrieveRelationalTableColumns(RelationalStorageAttributesDto relationalStorageAttributesDto,
                                                  String relationalSchemaName,
                                                  String relationalTableName)

Retrieves a list of actual schema columns for the specified relational table. This method uses actual JDBC connection to retrieve a description of table columns.

Parameters:

relationalStorageAttributesDto - the relational storage attributes DTO

relationalSchemaName - the name of the relational database schema

relationalTableName - the name of the relational table

Returns:

the list of schema columns for the specified relational table

updateRelationalTableSchema

BusinessObjectData updateRelationalTableSchema(RelationalTableRegistrationDto relationalTableRegistrationDto,
                                               List<SchemaColumn> schemaColumns)

Updates relational table schema 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:

relationalTableRegistrationDto - the relational table registration DTO

schemaColumns - the new relational table schema

Returns:

the information for the business object data created for the updated relational table registration

validateAndTrimRelationalTableRegistrationCreateRequest

void validateAndTrimRelationalTableRegistrationCreateRequest(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest)

Validates a relational table registration create request. This method also trims the request parameters.

Parameters:

relationalTableRegistrationCreateRequest - the relational table registration create request