org.finra.herd.service

Interface BusinessObjectFormatService

All Known Implementing Classes:

BusinessObjectFormatServiceImpl

public interface BusinessObjectFormatService

The business object definition format.

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormat	createBusinessObjectFormat(BusinessObjectFormatCreateRequest businessObjectFormatCreateRequest) Creates a new business object format.
BusinessObjectFormat	deleteBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey) Deletes a business object format.
BusinessObjectFormatDdl	generateBusinessObjectFormatDdl(BusinessObjectFormatDdlRequest businessObjectFormatDdlRequest) Retrieves the DDL to initialize the specified type of the database system (e.g.
BusinessObjectFormatDdlCollectionResponse	generateBusinessObjectFormatDdlCollection(BusinessObjectFormatDdlCollectionRequest businessObjectFormatDdlCollectionRequest) Retrieves the DDL to initialize the specified type of the database system (e.g.
BusinessObjectFormat	getBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey) Gets a business object format for the specified key.
BusinessObjectFormatKeys	getBusinessObjectFormats(BusinessObjectDefinitionKey businessObjectDefinitionKey, boolean latestBusinessObjectFormatVersion) Gets a list of business object formats for the specified business object definition name.
BusinessObjectFormatKeys	getBusinessObjectFormatsWithFilters(BusinessObjectDefinitionKey businessObjectDefinitionKey, String businessObjectFormatUsage, boolean latestBusinessObjectFormatVersion) Gets a list of business object formats for the specified business object definition name and business object format usage.
BusinessObjectFormat	updateBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey, BusinessObjectFormatUpdateRequest businessObjectFormatUpdateRequest) Updates a business object format.
BusinessObjectFormat	updateBusinessObjectFormatAttributeDefinitions(BusinessObjectFormatKey businessObjectFormatKey, BusinessObjectFormatAttributeDefinitionsUpdateRequest businessObjectFormatAttributeDefinitionsUpdateRequest) Replaces the list of attribute definitions for an existing business object format.
BusinessObjectFormat	updateBusinessObjectFormatAttributes(BusinessObjectFormatKey businessObjectFormatKey, BusinessObjectFormatAttributesUpdateRequest businessObjectFormatAttributesUpdateRequest) Updates a business object format attributes.
BusinessObjectFormat	updateBusinessObjectFormatParents(BusinessObjectFormatKey businessObjectFormatKey, BusinessObjectFormatParentsUpdateRequest businessObjectFormatParentsUpdateRequest) Update business object format parents
BusinessObjectFormat	updateBusinessObjectFormatRetentionInformation(BusinessObjectFormatKey businessObjectFormatKey, BusinessObjectFormatRetentionInformationUpdateRequest businessObjectFormatRetentionInformationUpdateRequest) Updates business object format retention information
BusinessObjectFormat	updateBusinessObjectFormatSchemaBackwardsCompatibilityChanges(BusinessObjectFormatKey businessObjectFormatKey, BusinessObjectFormatSchemaBackwardsCompatibilityUpdateRequest businessObjectFormatSchemaBackwardsCompatibilityUpdateRequest) Updates business object format schema backwards compatible changes

Method Detail

createBusinessObjectFormat

BusinessObjectFormat createBusinessObjectFormat(BusinessObjectFormatCreateRequest businessObjectFormatCreateRequest)

Creates a new business object format.

Parameters:

businessObjectFormatCreateRequest - the business object format create request.

Returns:

the created business object format.

updateBusinessObjectFormat

BusinessObjectFormat updateBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey,
                                                BusinessObjectFormatUpdateRequest businessObjectFormatUpdateRequest)

Updates a business object format.

Parameters:

businessObjectFormatKey - the business object format key

businessObjectFormatUpdateRequest - the business object format update request

Returns:

the updated business object format.

getBusinessObjectFormat

BusinessObjectFormat getBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey)

Gets a business object format for the specified key. This method starts a new transaction.

Parameters:

businessObjectFormatKey - the business object format key

Returns:

the business object format

deleteBusinessObjectFormat

BusinessObjectFormat deleteBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey)

Deletes a business object format.

Parameters:

businessObjectFormatKey - the business object format alternate key

Returns:

the business object format that was deleted

getBusinessObjectFormats

BusinessObjectFormatKeys getBusinessObjectFormats(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                  boolean latestBusinessObjectFormatVersion)

Gets a list of business object formats for the specified business object definition name.

Parameters:

businessObjectDefinitionKey - the business object definition key

latestBusinessObjectFormatVersion - specifies is only the latest (maximum) versions of the business object formats are returned

Returns:

the list of business object formats.

getBusinessObjectFormatsWithFilters

BusinessObjectFormatKeys getBusinessObjectFormatsWithFilters(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                             String businessObjectFormatUsage,
                                                             boolean latestBusinessObjectFormatVersion)

Gets a list of business object formats for the specified business object definition name and business object format usage.

Parameters:

businessObjectDefinitionKey - the business object definition key

businessObjectFormatUsage - the business object format usage

latestBusinessObjectFormatVersion - specifies is only the latest (maximum) versions of the business object formats are returned

Returns:

the list of business object formats.

generateBusinessObjectFormatDdl

BusinessObjectFormatDdl generateBusinessObjectFormatDdl(BusinessObjectFormatDdlRequest businessObjectFormatDdlRequest)

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating a table for the requested business object format. This method starts a new transaction.

Parameters:

businessObjectFormatDdlRequest - the business object format DDL request

Returns:

the business object format DDL information

generateBusinessObjectFormatDdlCollection

BusinessObjectFormatDdlCollectionResponse generateBusinessObjectFormatDdlCollection(BusinessObjectFormatDdlCollectionRequest businessObjectFormatDdlCollectionRequest)

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating tables for a collection of business object formats. This method starts a new transaction.

Parameters:

businessObjectFormatDdlCollectionRequest - the business object format DDL collection request

Returns:

the business object format DDL information

updateBusinessObjectFormatParents

BusinessObjectFormat updateBusinessObjectFormatParents(BusinessObjectFormatKey businessObjectFormatKey,
                                                       BusinessObjectFormatParentsUpdateRequest businessObjectFormatParentsUpdateRequest)

Update business object format parents

Parameters:

businessObjectFormatKey - business object format key

businessObjectFormatParentsUpdateRequest - business object format parents update request

Returns:

business object format

updateBusinessObjectFormatAttributes

BusinessObjectFormat updateBusinessObjectFormatAttributes(BusinessObjectFormatKey businessObjectFormatKey,
                                                          BusinessObjectFormatAttributesUpdateRequest businessObjectFormatAttributesUpdateRequest)

Updates a business object format attributes.

Parameters:

businessObjectFormatKey - the business object format key

businessObjectFormatAttributesUpdateRequest - the business object format attributes update request

Returns:

the updated business object format.

updateBusinessObjectFormatAttributeDefinitions

BusinessObjectFormat updateBusinessObjectFormatAttributeDefinitions(BusinessObjectFormatKey businessObjectFormatKey,
                                                                    BusinessObjectFormatAttributeDefinitionsUpdateRequest businessObjectFormatAttributeDefinitionsUpdateRequest)

Replaces the list of attribute definitions for an existing business object format.

Parameters:

businessObjectFormatKey - the business object format key

businessObjectFormatAttributeDefinitionsUpdateRequest - the business object format attribute definitions update request

Returns:

the updated business object format.

updateBusinessObjectFormatRetentionInformation

BusinessObjectFormat updateBusinessObjectFormatRetentionInformation(BusinessObjectFormatKey businessObjectFormatKey,
                                                                    BusinessObjectFormatRetentionInformationUpdateRequest businessObjectFormatRetentionInformationUpdateRequest)

Updates business object format retention information

Parameters:

businessObjectFormatKey - the business object format alternate key

businessObjectFormatRetentionInformationUpdateRequest - business object format retention information update request

Returns:

updated business object format

updateBusinessObjectFormatSchemaBackwardsCompatibilityChanges

BusinessObjectFormat updateBusinessObjectFormatSchemaBackwardsCompatibilityChanges(BusinessObjectFormatKey businessObjectFormatKey,
                                                                                   BusinessObjectFormatSchemaBackwardsCompatibilityUpdateRequest businessObjectFormatSchemaBackwardsCompatibilityUpdateRequest)

Updates business object format schema backwards compatible changes

Parameters:

businessObjectFormatKey - the business object format alternate key

businessObjectFormatSchemaBackwardsCompatibilityUpdateRequest - business object format schema backwards compatible changes update request

Returns:

updated business object format