org.finra.herd.service

Interface BusinessObjectDataInitiateRestoreHelperService

All Known Implementing Classes:

BusinessObjectDataInitiateRestoreHelperServiceImpl

public interface BusinessObjectDataInitiateRestoreHelperService

The helper service class for the business object data initiate a restore request functionality.

Method Summary

Modifier and Type	Method and Description
BusinessObjectData	executeInitiateRestoreAfterStep(BusinessObjectDataRestoreDto businessObjectDataRestoreDto) Executes an after step for the initiation of a business object data restore request.
void	executeS3SpecificSteps(BusinessObjectDataRestoreDto businessObjectDataRestoreDto) Executes S3 specific steps for the initiation of a business object data restore request.
BusinessObjectDataRestoreDto	prepareToInitiateRestore(BusinessObjectDataKey businessObjectDataKey, Integer expirationInDays, String archiveRetrievalOption) Prepares for the business object data initiate a restore request by validating the business object data along with other related database entities.

Method Detail

executeInitiateRestoreAfterStep

BusinessObjectData executeInitiateRestoreAfterStep(BusinessObjectDataRestoreDto businessObjectDataRestoreDto)

Executes an after step for the initiation of a business object data restore request.

Parameters:

businessObjectDataRestoreDto - the DTO that holds various parameters needed to perform a business object data restore

Returns:

the business object data information

executeS3SpecificSteps

void executeS3SpecificSteps(BusinessObjectDataRestoreDto businessObjectDataRestoreDto)

Executes S3 specific steps for the initiation of a business object data restore request. The method also updates the specified DTO.

Parameters:

businessObjectDataRestoreDto - the DTO that holds various parameters needed to perform a business object data restore

prepareToInitiateRestore

BusinessObjectDataRestoreDto prepareToInitiateRestore(BusinessObjectDataKey businessObjectDataKey,
                                                      Integer expirationInDays,
                                                      String archiveRetrievalOption)

Prepares for the business object data initiate a restore request by validating the business object data along with other related database entities. The method also creates and returns a business object data restore DTO.

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.

Returns:

the DTO that holds various parameters needed to perform a business object data restore