org.finra.herd.service

Interface BusinessObjectDataService

All Known Implementing Classes:

BusinessObjectDataServiceImpl

public interface BusinessObjectDataService

The business object data service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_PARTITION_VALUE_TOKEN
static String	MIN_PARTITION_VALUE_TOKEN

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataAvailability	checkBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest) Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data.
BusinessObjectDataAvailabilityCollectionResponse	checkBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest request) Performs an availability check for a collection of business object data.
BusinessObjectData	createBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest) Creates a new business object data from the request information.
BusinessObjectData	deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Boolean deleteFiles) Deletes an existing business object data.
BusinessObjectDataDdl	generateBusinessObjectDataDdl(BusinessObjectDataDdlRequest businessObjectDataDdlRequest) Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage.
BusinessObjectDataDdlCollectionResponse	generateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest) Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storages.
BusinessObjectData	getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory) Retrieves existing business object data entry information.
BusinessObjectDataVersions	getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey) Retrieves a list of existing business object data versions, if any.
BusinessObjectDataInvalidateUnregisteredResponse	invalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest) Creates business object data registrations in INVALID status if the S3 object exists, but no registration exists.
BusinessObjectData	restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey) Initiates a restore request for a currently archived business object data.
BusinessObjectData	retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetryStoragePolicyTransitionRequest request) Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation.
BusinessObjectDataSearchResult	searchBusinessObjectData(BusinessObjectDataSearchRequest request) Search business object data based on the request

Field Detail

MAX_PARTITION_VALUE_TOKEN

static final String MAX_PARTITION_VALUE_TOKEN

See Also:

Constant Field Values

MIN_PARTITION_VALUE_TOKEN

static final String MIN_PARTITION_VALUE_TOKEN

See Also:

Constant Field Values

Method Detail

createBusinessObjectData

BusinessObjectData createBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest)

Creates a new business object data from the request information. Creates its own transaction.

Parameters:

businessObjectDataCreateRequest - the business object data create request

Returns:

the newly created and persisted business object data.

getBusinessObjectData

BusinessObjectData getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                         String businessObjectFormatPartitionKey,
                                         String businessObjectDataStatus,
                                         Boolean includeBusinessObjectDataStatusHistory)

Retrieves existing business object data entry information. This method starts a new transaction.

Parameters:

businessObjectDataKey - the business object data key

businessObjectFormatPartitionKey - the business object format partition key

businessObjectDataStatus - the business object data status, may be null

includeBusinessObjectDataStatusHistory - specifies to include business object data status history in the response

Returns:

the retrieved business object data information

getBusinessObjectDataVersions

BusinessObjectDataVersions getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey)

Retrieves a list of existing business object data versions, if any.

Parameters:

businessObjectDataKey - the business object data key with possibly missing business object format and/or data version values

Returns:

the retrieved business object data versions

deleteBusinessObjectData

BusinessObjectData deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                            Boolean deleteFiles)

Deletes an existing business object data.

Parameters:

businessObjectDataKey - the business object data key

deleteFiles - specifies if data files should be deleted or not

Returns:

the deleted business object data information

checkBusinessObjectDataAvailability

BusinessObjectDataAvailability checkBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest businessObjectDataAvailabilityRequest)

Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data. Creates its own transaction.

Parameters:

businessObjectDataAvailabilityRequest - the business object data availability request

Returns:

the business object data availability information

checkBusinessObjectDataAvailabilityCollection

BusinessObjectDataAvailabilityCollectionResponse checkBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest request)

Performs an availability check for a collection of business object data.

Parameters:

request - the business object data availability collection request

Returns:

the business object data availability information

generateBusinessObjectDataDdl

BusinessObjectDataDdl generateBusinessObjectDataDdl(BusinessObjectDataDdlRequest businessObjectDataDdlRequest)

Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage. This method starts a new transaction.

Parameters:

businessObjectDataDdlRequest - the business object data DDL request

Returns:

the business object data DDL information

generateBusinessObjectDataDdlCollection

BusinessObjectDataDdlCollectionResponse generateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest)

Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storages. This method starts a new transaction.

Parameters:

businessObjectDataDdlCollectionRequest - the business object data DDL collection request

Returns:

the business object data DDL information

invalidateUnregisteredBusinessObjectData

BusinessObjectDataInvalidateUnregisteredResponse invalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest)

Creates business object data registrations in INVALID status if the S3 object exists, but no registration exists.

Parameters:

businessObjectDataInvalidateUnregisteredRequest - BusinessObjectDataInvalidateUnregisteredRequest

Returns:

BusinessObjectDataInvalidateUnregisteredResponse

retryStoragePolicyTransition

BusinessObjectData retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey,
                                                BusinessObjectDataRetryStoragePolicyTransitionRequest request)

Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation.

Parameters:

businessObjectDataKey - the business object data key

request - the information needed to retry a storage policy transition

Returns:

the business object data information

restoreBusinessObjectData

BusinessObjectData restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey)

Initiates a restore request for a currently archived business object data.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the business object data information

searchBusinessObjectData

BusinessObjectDataSearchResult searchBusinessObjectData(BusinessObjectDataSearchRequest request)

Search business object data based on the request

Parameters:

request - search request

Returns:

business data search result