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.
BusinessObjectData	destroyBusinessObjectData(BusinessObjectDataKey businessObjectDataKey) Initiates destruction process for an existing business object data by using S3 tagging to mark the relative S3 files for deletion and updating statuses of the business object data and its storage unit.
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.
BusinessObjectDataPartitions	generateBusinessObjectDataPartitions(BusinessObjectDataPartitionsRequest businessObjectDataPartitionsRequest) Generates the partitions information for a range of requested business object data in the specified storage.
BusinessObjectDataKeys	getAllBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey) Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object definition.
BusinessObjectDataKeys	getAllBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey) Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object format.
BusinessObjectData	getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory, Boolean excludeBusinessObjectDataStorageFiles) 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, Integer expirationInDays, String archiveRetrievalOption) 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.
BusinessObjectDataSearchResultPagingInfoDto	searchBusinessObjectData(Integer pageNum, Integer pageSize, BusinessObjectDataSearchRequest request) Search business object data based on the request
BusinessObjectData	updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest) Updates attributes for business object data.
BusinessObjectData	updateBusinessObjectDataParents(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataParentsUpdateRequest businessObjectDataParentsUpdateRequest) Updates parents for business object data.
BusinessObjectData	updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest) Updates retention information for an existing business object data.

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

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

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.

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

destroyBusinessObjectData

BusinessObjectData destroyBusinessObjectData(BusinessObjectDataKey businessObjectDataKey)

Initiates destruction process for an existing business object data by using S3 tagging to mark the relative S3 files for deletion and updating statuses of the business object data and its storage unit. The S3 data then gets deleted by S3 bucket lifecycle policy that is based on S3 tagging.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the business object data 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

generateBusinessObjectDataPartitions

BusinessObjectDataPartitions generateBusinessObjectDataPartitions(BusinessObjectDataPartitionsRequest businessObjectDataPartitionsRequest)

Generates the partitions information for a range of requested business object data in the specified storage. This method starts a new transaction.

Parameters:

businessObjectDataPartitionsRequest - the business object data partitions request

Returns:

the business object data partitions information

getAllBusinessObjectDataByBusinessObjectDefinition

BusinessObjectDataKeys getAllBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object definition.

Parameters:

businessObjectDefinitionKey - the business object definition key (case-insensitive)

Returns:

the list of business object data keys

getAllBusinessObjectDataByBusinessObjectFormat

BusinessObjectDataKeys getAllBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey)

Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object format.

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive)

Returns:

the list of business object data keys

getBusinessObjectData

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

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

includeStorageUnitStatusHistory - specifies to include storage unit status history for each storage unit in the response

excludeBusinessObjectDataStorageFiles - specifies to exclude storage files 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

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

restoreBusinessObjectData

BusinessObjectData restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                             Integer expirationInDays,
                                             String archiveRetrievalOption)

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

Parameters:

businessObjectDataKey - the business object data key

expirationInDays - the the time, in days, between when the business object data is restored to the S3 bucket and when it expires

archiveRetrievalOption - the archive retrieval option when restoring an archived object. Currently three options are supported: Expedited, Standard, and Bulk

Returns:

the business object data information

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

searchBusinessObjectData

BusinessObjectDataSearchResultPagingInfoDto searchBusinessObjectData(Integer pageNum,
                                                                     Integer pageSize,
                                                                     BusinessObjectDataSearchRequest request)

Search business object data based on the request

Parameters:

pageNum - if pageNum parameter is specified, results contain the appropriate page specified. Page numbers are one-based - that is the first page number is one.

pageSize - if pageSize parameter is specified, results contain that number of business object data (unless it is the end of the result set).

request - search request

Returns:

business data search result with the paging information

updateBusinessObjectDataAttributes

BusinessObjectData updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey,
                                                      BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest)

Updates attributes for business object data.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataAttributesUpdateRequest - the information needed to update the business object data attributes

Returns:

the updated business object data information

updateBusinessObjectDataParents

BusinessObjectData updateBusinessObjectDataParents(BusinessObjectDataKey businessObjectDataKey,
                                                   BusinessObjectDataParentsUpdateRequest businessObjectDataParentsUpdateRequest)

Updates parents for business object data.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataParentsUpdateRequest - the information needed to update the business object data parents

Returns:

the updated business object data information

updateBusinessObjectDataRetentionInformation

BusinessObjectData updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey,
                                                                BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest)

Updates retention information for an existing business object data.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataRetentionInformationUpdateRequest - the business object data retention information update request

Returns:

the business object data information