Uses of Class
org.finra.herd.model.api.xml.BusinessObjectDataKey

Packages that use BusinessObjectDataKey

Package	Description
org.finra.herd.dao
org.finra.herd.dao.impl
org.finra.herd.model.api.xml
org.finra.herd.model.dto
org.finra.herd.service
org.finra.herd.service.helper
org.finra.herd.service.impl
org.finra.herd.tools.common.databridge
org.finra.herd.tools.retention.destroyer
org.finra.herd.tools.uploader

Uses of BusinessObjectDataKey in org.finra.herd.dao

Methods in org.finra.herd.dao that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
List<BusinessObjectDataKey>	BusinessObjectDataDao.getBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity, Integer maxResults) Gets a list of keys for business object data registered under specified business object definition entity.
List<BusinessObjectDataKey>	BusinessObjectDataDao.getBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatEntity businessObjectFormatEntity, Integer maxResults) Gets a list of keys for business object data registered under specified business object format entity.

Methods in org.finra.herd.dao with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataEntity	BusinessObjectDataDao.getBusinessObjectDataByAltKey(BusinessObjectDataKey businessObjectDataKey) Retrieves business object data by it's key.
BusinessObjectDataEntity	BusinessObjectDataDao.getBusinessObjectDataByAltKeyAndStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Retrieves business object data by it's key.
List<BusinessObjectDataEntity>	BusinessObjectDataDao.getBusinessObjectDataEntities(BusinessObjectDataKey businessObjectDataKey) Retrieves business object data versions that match the specified business object data key with potentially missing business object format and/or data version values.
Integer	BusinessObjectDataDao.getBusinessObjectDataMaxVersion(BusinessObjectDataKey businessObjectDataKey) Gets a maximum available version of the specified business object data.
List<BusinessObjectDataNotificationRegistrationEntity>	BusinessObjectDataNotificationRegistrationDao.getBusinessObjectDataNotificationRegistrations(String notificationEventTypeCode, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus, String notificationRegistrationStatus) Retrieves a list of business object data notification registration entities that match given input parameters.
List<StorageUnitNotificationRegistrationEntity>	StorageUnitNotificationRegistrationDao.getStorageUnitNotificationRegistrations(String notificationEventTypeCode, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus, String notificationRegistrationStatus) Retrieves a list of storage unit notification registration entities that match given input parameters.

Uses of BusinessObjectDataKey in org.finra.herd.dao.impl

Methods in org.finra.herd.dao.impl that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
List<BusinessObjectDataKey>	BusinessObjectDataDaoImpl.getBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity, Integer maxResults)
List<BusinessObjectDataKey>	BusinessObjectDataDaoImpl.getBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatEntity businessObjectFormatEntity, Integer maxResults)

Methods in org.finra.herd.dao.impl with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataEntity	BusinessObjectDataDaoImpl.getBusinessObjectDataByAltKey(BusinessObjectDataKey businessObjectDataKey)
BusinessObjectDataEntity	BusinessObjectDataDaoImpl.getBusinessObjectDataByAltKeyAndStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus)
List<BusinessObjectDataEntity>	BusinessObjectDataDaoImpl.getBusinessObjectDataEntities(BusinessObjectDataKey businessObjectDataKey)
Integer	BusinessObjectDataDaoImpl.getBusinessObjectDataMaxVersion(BusinessObjectDataKey businessObjectDataKey)
List<BusinessObjectDataNotificationRegistrationEntity>	BusinessObjectDataNotificationRegistrationDaoImpl.getBusinessObjectDataNotificationRegistrations(String notificationEventTypeCode, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus, String notificationRegistrationStatus)
protected javax.persistence.criteria.Predicate	AbstractHerdDao.getQueryRestriction(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, javax.persistence.criteria.From<?,BusinessObjectFormatEntity> businessObjectFormatEntity, javax.persistence.criteria.From<?,FileTypeEntity> fileTypeEntity, javax.persistence.criteria.From<?,BusinessObjectDefinitionEntity> businessObjectDefinitionEntity, BusinessObjectDataKey businessObjectDataKey) TODO This method may be bdata specific.
protected javax.persistence.criteria.Predicate	AbstractHerdDao.getQueryRestrictionOnPartitionValues(javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.From<?,BusinessObjectDataEntity> businessObjectDataEntity, BusinessObjectDataKey businessObjectDataKey) TODO This method may be bdata specific.
List<StorageUnitNotificationRegistrationEntity>	StorageUnitNotificationRegistrationDaoImpl.getStorageUnitNotificationRegistrations(String notificationEventTypeCode, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus, String notificationRegistrationStatus)

Uses of BusinessObjectDataKey in org.finra.herd.model.api.xml

Fields in org.finra.herd.model.api.xml declared as BusinessObjectDataKey

Modifier and Type	Field and Description
protected BusinessObjectDataKey	BusinessObjectDataStatusUpdateResponse.businessObjectDataKey
protected BusinessObjectDataKey	BusinessObjectDataVersion.businessObjectDataKey
protected BusinessObjectDataKey	BusinessObjectDataStatusInformation.businessObjectDataKey

Fields in org.finra.herd.model.api.xml with type parameters of type BusinessObjectDataKey

Modifier and Type	Field and Description
protected List<BusinessObjectDataKey>	BusinessObjectData.businessObjectDataChildren
protected List<BusinessObjectDataKey>	BusinessObjectDataKeys.businessObjectDataKeys
protected List<BusinessObjectDataKey>	BusinessObjectDataCreateRequest.businessObjectDataParents
protected List<BusinessObjectDataKey>	BusinessObjectData.businessObjectDataParents

Methods in org.finra.herd.model.api.xml that return BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataKey	ObjectFactory.createBusinessObjectDataKey() Create an instance of BusinessObjectDataKey
BusinessObjectDataKey	BusinessObjectDataStatusUpdateResponse.getBusinessObjectDataKey() Gets the value of the businessObjectDataKey property.
BusinessObjectDataKey	BusinessObjectDataVersion.getBusinessObjectDataKey() Gets the value of the businessObjectDataKey property.
BusinessObjectDataKey	BusinessObjectDataStatusInformation.getBusinessObjectDataKey() Gets the value of the businessObjectDataKey property.

Methods in org.finra.herd.model.api.xml that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
List<BusinessObjectDataKey>	BusinessObjectData.getBusinessObjectDataChildren()
List<BusinessObjectDataKey>	BusinessObjectDataKeys.getBusinessObjectDataKeys() Gets the value of the businessObjectDataKeys property.
List<BusinessObjectDataKey>	BusinessObjectDataCreateRequest.getBusinessObjectDataParents()
List<BusinessObjectDataKey>	BusinessObjectData.getBusinessObjectDataParents()

Methods in org.finra.herd.model.api.xml with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
void	BusinessObjectDataStatusUpdateResponse.setBusinessObjectDataKey(BusinessObjectDataKey value) Sets the value of the businessObjectDataKey property.
void	BusinessObjectDataVersion.setBusinessObjectDataKey(BusinessObjectDataKey value) Sets the value of the businessObjectDataKey property.
void	BusinessObjectDataStatusInformation.setBusinessObjectDataKey(BusinessObjectDataKey value) Sets the value of the businessObjectDataKey property.

Method parameters in org.finra.herd.model.api.xml with type arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
void	BusinessObjectData.setBusinessObjectDataChildren(List<BusinessObjectDataKey> businessObjectDataChildren)
void	BusinessObjectDataCreateRequest.setBusinessObjectDataParents(List<BusinessObjectDataKey> businessObjectDataParents)
void	BusinessObjectData.setBusinessObjectDataParents(List<BusinessObjectDataKey> businessObjectDataParents)

Constructors in org.finra.herd.model.api.xml with parameters of type BusinessObjectDataKey

Constructor and Description
BusinessObjectDataStatusInformation(BusinessObjectDataKey businessObjectDataKey, String status) Fully-initialising value constructor
BusinessObjectDataStatusUpdateResponse(BusinessObjectDataKey businessObjectDataKey, String status, String previousStatus) Fully-initialising value constructor
BusinessObjectDataVersion(BusinessObjectDataKey businessObjectDataKey, String status) Fully-initialising value constructor

Constructor parameters in org.finra.herd.model.api.xml with type arguments of type BusinessObjectDataKey

Constructor and Description
BusinessObjectData(int id, String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, int businessObjectFormatVersion, String partitionKey, String partitionValue, List<String> subPartitionValues, int version, Boolean latestVersion, String status, List<StorageUnit> storageUnits, List<Attribute> attributes, List<BusinessObjectDataKey> businessObjectDataParents, List<BusinessObjectDataKey> businessObjectDataChildren, List<BusinessObjectDataStatusChangeEvent> businessObjectDataStatusHistory, XMLGregorianCalendar retentionExpirationDate) Fully-initialising value constructor
BusinessObjectData(int id, String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, int businessObjectFormatVersion, String partitionKey, String partitionValue, List<String> subPartitionValues, int version, Boolean latestVersion, String status, List<StorageUnit> storageUnits, List<Attribute> attributes, List<BusinessObjectDataKey> businessObjectDataParents, List<BusinessObjectDataKey> businessObjectDataChildren, List<BusinessObjectDataStatusChangeEvent> businessObjectDataStatusHistory, XMLGregorianCalendar retentionExpirationDate) Fully-initialising value constructor
BusinessObjectDataCreateRequest(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionKey, String partitionValue, List<String> subPartitionValues, String status, List<StorageUnitCreateRequest> storageUnits, List<Attribute> attributes, List<BusinessObjectDataKey> businessObjectDataParents, Boolean createNewVersion) Fully-initialising value constructor
BusinessObjectDataKeys(List<BusinessObjectDataKey> businessObjectDataKeys) Fully-initialising value constructor

Uses of BusinessObjectDataKey in org.finra.herd.model.dto

Methods in org.finra.herd.model.dto that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
List<BusinessObjectDataKey>	DownloaderOutputManifestDto.getBusinessObjectDataChildren()
List<BusinessObjectDataKey>	DownloaderOutputManifestDto.getBusinessObjectDataParents()
List<BusinessObjectDataKey>	UploaderInputManifestDto.getBusinessObjectDataParents()

Method parameters in org.finra.herd.model.dto with type arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
void	DownloaderOutputManifestDto.setBusinessObjectDataChildren(List<BusinessObjectDataKey> businessObjectDataChildren)
void	DownloaderOutputManifestDto.setBusinessObjectDataParents(List<BusinessObjectDataKey> businessObjectDataParents)
void	UploaderInputManifestDto.setBusinessObjectDataParents(List<BusinessObjectDataKey> businessObjectDataParents)

Uses of BusinessObjectDataKey in org.finra.herd.service

Methods in org.finra.herd.service that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
List<BusinessObjectDataKey>	FileUploadCleanupService.deleteBusinessObjectData(String storageName, int thresholdMinutes) Marks as DELETED any dangling business object data records having storage files associated with the specified storage.

Methods in org.finra.herd.service with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectData	BusinessObjectDataService.deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Boolean deleteFiles) Deletes an existing business object data.
BusinessObjectData	BusinessObjectDataService.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.
BusinessObjectData	BusinessObjectDataService.getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory) Retrieves existing business object data entry information.
BusinessObjectDataAttributeKeys	BusinessObjectDataAttributeService.getBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey) Gets a list of keys for all existing business object data attributes.
BusinessObjectDataStatusInformation	BusinessObjectDataStatusService.getBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey) Retrieves status information for an existing business object data.
BusinessObjectDataVersions	BusinessObjectDataService.getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey) Retrieves a list of existing business object data versions, if any.
S3KeyPrefixInformation	StorageUnitService.getS3KeyPrefix(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String storageName, Boolean createNewVersion) Gets the S3 key prefix.
StorageUnitDownloadCredential	StorageUnitService.getStorageUnitDownloadCredential(BusinessObjectDataKey businessObjectDataKey, String storageName) Gets the AWS credential to download to the specified storage unit.
StorageUnitUploadCredential	StorageUnitService.getStorageUnitUploadCredential(BusinessObjectDataKey businessObjectDataKey, Boolean createNewVersion, String storageName) Gets the AWS credential to upload to the specified storage unit.
void	BusinessObjectDataInitiateDestroyHelperService.prepareToInitiateDestroy(BusinessObjectDataDestroyDto businessObjectDataDestroyDto, BusinessObjectDataKey businessObjectDataKey) Prepares to initiate a business object data destroy process by validating specified business object data along with other related database entities.
BusinessObjectDataRestoreDto	BusinessObjectDataInitiateRestoreHelperService.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.
Future<Void>	NotificationEventService.processBusinessObjectDataNotificationEventAsync(NotificationEventTypeEntity.EventTypesBdata notificationEventType, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus) Asynchronously handles the notification for the business object data changes.
List<Object>	NotificationEventService.processBusinessObjectDataNotificationEventSync(NotificationEventTypeEntity.EventTypesBdata notificationEventType, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus) Synchronously handles the notification for the business object data changes.
List<NotificationMessage>	MessageNotificationEventService.processBusinessObjectDataStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus) Handles notifications for the business object data status changes.
Future<Void>	NotificationEventService.processStorageUnitNotificationEventAsync(NotificationEventTypeEntity.EventTypesStorageUnit notificationEventType, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus) Asynchronously handles the notification for the storage unit changes.
List<Object>	NotificationEventService.processStorageUnitNotificationEventSync(NotificationEventTypeEntity.EventTypesStorageUnit notificationEventType, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus) Synchronously handles the notification for the storage unit changes.
List<NotificationMessage>	MessageNotificationEventService.processStorageUnitStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus) Handles notifications for the storage unit status changes.
BusinessObjectData	BusinessObjectDataService.restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Integer expirationInDays, String archiveRetrievalOption) Initiates a restore request for a currently archived business object data.
BusinessObjectData	BusinessObjectDataService.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.
BusinessObjectData	BusinessObjectDataService.updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest) Updates attributes for business object data.
BusinessObjectData	BusinessObjectDataService.updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest) Updates retention information for an existing business object data.
BusinessObjectDataStatusUpdateResponse	BusinessObjectDataStatusService.updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataStatusUpdateRequest request) Updates status of the business object data.
void	UploadDownloadHelperService.updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Updates the business object data status in a new transaction.

Uses of BusinessObjectDataKey in org.finra.herd.service.helper

Methods in org.finra.herd.service.helper that return BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataKey	BusinessObjectDataHelper.createBusinessObjectDataKey(BusinessObjectData businessObjectData) Creates a business object data key from a business object data DTO.
BusinessObjectDataKey	BusinessObjectDataHelper.createBusinessObjectDataKeyFromEntity(BusinessObjectDataEntity businessObjectDataEntity) Creates a business object data key from a business object data entity.
BusinessObjectDataKey	BusinessObjectDataHelper.createBusinessObjectDataKeyFromStorageUnitKey(BusinessObjectDataStorageUnitKey storageUnitKey) Creates a business object data key from a storage unit key.
BusinessObjectDataKey	BusinessObjectDataHelper.getBusinessObjectDataKey(BusinessObjectData businessObjectData) Returns a business object data key for the business object data.
BusinessObjectDataKey	BusinessObjectDataHelper.getBusinessObjectDataKey(BusinessObjectDataEntity businessObjectDataEntity) Returns a business object data key for the business object data entity.
BusinessObjectDataKey	StorageUnitHelper.getBusinessObjectDataKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey) Gets a business object data key from a storage unit key.

Methods in org.finra.herd.service.helper with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
String	S3KeyPrefixHelper.buildS3KeyPrefix(StorageEntity storageEntity, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataKey businessObjectDataKey) Returns the S3 object key prefix based on the given storage, business object format and business object data key.
String	S3KeyPrefixHelper.buildS3KeyPrefix(String s3KeyPrefixVelocityTemplate, BusinessObjectFormatEntity businessObjectFormatEntity, BusinessObjectDataKey businessObjectDataKey, String storageName) Returns the S3 object key prefix based on the given velocity template, business object format and business object data key.
String	S3KeyPrefixHelper.buildS3KeyPrefix(String s3KeyPrefixVelocityTemplate, String dataProviderName, BusinessObjectFormat businessObjectFormat, BusinessObjectDataKey businessObjectDataKey, String storageName) Returns S3 key prefix constructed per specified velocity template.
String	BusinessObjectDataHelper.businessObjectDataKeyToString(BusinessObjectDataKey businessObjectDataKey) Returns a string representation of the business object data key.
int	BusinessObjectDataKeyComparator.compare(BusinessObjectDataKey data1, BusinessObjectDataKey data2)
BusinessObjectDataStorageUnitKey	StorageUnitHelper.createBusinessObjectDataStorageUnitKey(BusinessObjectDataKey businessObjectDataKey, String storageName) Creates a business object data storage unit key from business object data key and storage name.
BusinessObjectDataStorageUnitKey	StorageUnitHelper.createStorageUnitKey(BusinessObjectDataKey businessObjectDataKey, String storageName) Creates a storage unit key from a business object data key and a storage name.
List<StorageFile>	StorageFileHelper.getAndValidateStorageFiles(StorageUnitEntity storageUnitEntity, String s3KeyPrefix, String storageName, BusinessObjectDataKey businessObjectDataKey) Retrieves and validates a list of storage files registered with the specified storage unit.
List<StorageFile>	StorageFileHelper.getAndValidateStorageFilesIfPresent(StorageUnitEntity storageUnitEntity, String s3KeyPrefix, String storageName, BusinessObjectDataKey businessObjectDataKey) Retrieves and validates a list of storage files registered with the specified storage unit.
BusinessObjectDataAttributeKey	BusinessObjectDataAttributeHelper.getBusinessObjectDataAttributeKey(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataAttributeName) Returns a business object data attribute key built per specified parameters.
BusinessObjectDataEntity	BusinessObjectDataDaoHelper.getBusinessObjectDataEntity(BusinessObjectDataKey businessObjectDataKey) Gets business object data based on the key information.
BusinessObjectDataEntity	BusinessObjectDataDaoHelper.getBusinessObjectDataEntityByKeyAndStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Retrieves business object data by it's key.
BusinessObjectFormatKey	BusinessObjectFormatHelper.getBusinessObjectFormatKey(BusinessObjectDataKey businessObjectDataKey) Gets business object format key from the specified business object data key.
List<HivePartitionDto>	Hive13DdlGenerator.getHivePartitions(BusinessObjectDataKey businessObjectDataKey, List<SchemaColumn> autoDiscoverableSubPartitionColumns, String s3KeyPrefix, Collection<String> storageFiles, String storageName) Gets a list of Hive partitions.
List<String>	BusinessObjectDataHelper.getPartitionFilter(BusinessObjectDataKey businessObjectDataKey, List<String> samplePartitionFilter) Returns a partition filter that the specified business object data key would match to.
List<String>	BusinessObjectDataHelper.getPrimaryAndSubPartitionValues(BusinessObjectDataKey businessObjectDataKey) Returns a list of primary and sub-partition values per specified business object data.
StorageFileEntity	StorageFileDaoHelper.getStorageFileEntity(StorageUnitEntity storageUnitEntity, String filePath, BusinessObjectDataKey businessObjectDataKey) Retrieves storage file by storage unit entity and file path.
BusinessObjectData	BusinessObjectDataRetryStoragePolicyTransitionHelper.retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetryStoragePolicyTransitionRequest request) Executes a retry of the storage policy transition and return the business object data information.
void	BusinessObjectDataHelper.validateBusinessObjectDataKey(BusinessObjectDataKey key, boolean businessObjectFormatVersionRequired, boolean businessObjectDataVersionRequired) Validates the business object data key.
void	StorageFileHelper.validateRegisteredS3Files(List<StorageFile> expectedStorageFiles, List<com.amazonaws.services.s3.model.S3ObjectSummary> s3ObjectSummaries, String storageName, BusinessObjectDataKey businessObjectDataKey) Validates registered S3 files per list of expected storage files.
void	StorageFileHelper.validateStorageFilePaths(Collection<String> storageFilePaths, String s3KeyPrefix, BusinessObjectDataKey businessObjectDataKey, String storageName) Validates a list of storage file paths.
void	StorageFileDaoHelper.validateStorageFilesCount(String storageName, BusinessObjectDataKey businessObjectDataKey, String s3KeyPrefix, int expectedStorageFilesCount) Validates that storage does not have any other registered storage files that start with the specified S3 key prefix, but belong to some other business object data instances.

Uses of BusinessObjectDataKey in org.finra.herd.service.impl

Methods in org.finra.herd.service.impl that return BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataKey	UploadDownloadServiceImpl.CompleteUploadSingleMessageResult.getSourceBusinessObjectDataKey()
BusinessObjectDataKey	UploadDownloadServiceImpl.CompleteUploadSingleMessageResult.getTargetBusinessObjectDataKey()

Methods in org.finra.herd.service.impl that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
List<BusinessObjectDataKey>	FileUploadCleanupServiceImpl.deleteBusinessObjectData(String storageName, int thresholdMinutes)

Methods in org.finra.herd.service.impl with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectData	BusinessObjectDataServiceImpl.deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Boolean deleteFiles)
BusinessObjectData	BusinessObjectDataServiceImpl.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.
BusinessObjectData	BusinessObjectDataServiceImpl.getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory)
BusinessObjectDataAttributeKeys	BusinessObjectDataAttributeServiceImpl.getBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey) Gets a list of keys for all existing business object data attributes.
protected BusinessObjectDataAttributeKeys	BusinessObjectDataAttributeServiceImpl.getBusinessObjectDataAttributesImpl(BusinessObjectDataKey businessObjectDataKey) Gets a list of keys for all existing business object data attributes.
BusinessObjectDataStatusInformation	BusinessObjectDataStatusServiceImpl.getBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey) Retrieves status information for an existing business object data.
protected BusinessObjectDataStatusInformation	BusinessObjectDataStatusServiceImpl.getBusinessObjectDataStatusImpl(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey) Retrieves status information for an existing business object data.
BusinessObjectDataVersions	BusinessObjectDataServiceImpl.getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey)
S3KeyPrefixInformation	StorageUnitServiceImpl.getS3KeyPrefix(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String storageName, Boolean createNewVersion)
protected S3KeyPrefixInformation	StorageUnitServiceImpl.getS3KeyPrefixImpl(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String storageName, Boolean createNewVersion) Gets the S3 key prefix.
StorageUnitDownloadCredential	StorageUnitServiceImpl.getStorageUnitDownloadCredential(BusinessObjectDataKey businessObjectDataKey, String storageName)
StorageUnitUploadCredential	StorageUnitServiceImpl.getStorageUnitUploadCredential(BusinessObjectDataKey businessObjectDataKey, Boolean createNewVersion, String storageName)
void	BusinessObjectDataInitiateDestroyHelperServiceImpl.prepareToInitiateDestroy(BusinessObjectDataDestroyDto businessObjectDataDestroyDto, BusinessObjectDataKey businessObjectDataKey) Prepares to initiate a business object data destroy process by validating specified business object data along with other related database entities.
BusinessObjectDataRestoreDto	BusinessObjectDataInitiateRestoreHelperServiceImpl.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.
protected BusinessObjectDataRestoreDto	BusinessObjectDataInitiateRestoreHelperServiceImpl.prepareToInitiateRestoreImpl(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.
Future<Void>	NotificationEventServiceImpl.processBusinessObjectDataNotificationEventAsync(NotificationEventTypeEntity.EventTypesBdata notificationEventType, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus)
List<Object>	NotificationEventServiceImpl.processBusinessObjectDataNotificationEventSync(NotificationEventTypeEntity.EventTypesBdata notificationEventType, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus)
List<NotificationMessage>	MessageNotificationEventServiceImpl.processBusinessObjectDataStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus)
Future<Void>	NotificationEventServiceImpl.processStorageUnitNotificationEventAsync(NotificationEventTypeEntity.EventTypesStorageUnit notificationEventType, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus)
List<Object>	NotificationEventServiceImpl.processStorageUnitNotificationEventSync(NotificationEventTypeEntity.EventTypesStorageUnit notificationEventType, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus)
List<NotificationMessage>	MessageNotificationEventServiceImpl.processStorageUnitStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus)
BusinessObjectData	BusinessObjectDataServiceImpl.restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Integer expirationInDays, String archiveRetrievalOption) Initiates a restore request for a currently archived business object data.
BusinessObjectData	BusinessObjectDataServiceImpl.retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetryStoragePolicyTransitionRequest request)
void	UploadDownloadServiceImpl.CompleteUploadSingleMessageResult.setSourceBusinessObjectDataKey(BusinessObjectDataKey sourceBusinessObjectDataKey)
void	UploadDownloadServiceImpl.CompleteUploadSingleMessageResult.setTargetBusinessObjectDataKey(BusinessObjectDataKey targetBusinessObjectDataKey)
BusinessObjectData	BusinessObjectDataServiceImpl.updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest)
BusinessObjectData	BusinessObjectDataServiceImpl.updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest)
BusinessObjectDataStatusUpdateResponse	BusinessObjectDataStatusServiceImpl.updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataStatusUpdateRequest request) Updates status of the business object data.
void	UploadDownloadHelperServiceImpl.updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus)
protected BusinessObjectDataStatusUpdateResponse	BusinessObjectDataStatusServiceImpl.updateBusinessObjectDataStatusImpl(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataStatusUpdateRequest request) Updates status of the business object data.
protected void	UploadDownloadHelperServiceImpl.updateBusinessObjectDataStatusImpl(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Implementation of the update business object data status.

Uses of BusinessObjectDataKey in org.finra.herd.tools.common.databridge

Methods in org.finra.herd.tools.common.databridge with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataStorageFilesCreateResponse	DataBridgeWebClient.addStorageFiles(BusinessObjectDataKey businessObjectDataKey, UploaderInputManifestDto manifest, S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto, String storageName) Calls the registration server to add storage files to the business object data.
BusinessObjectDataStatusUpdateResponse	DataBridgeWebClient.updateBusinessObjectDataStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Updates the business object data status.

Uses of BusinessObjectDataKey in org.finra.herd.tools.retention.destroyer

Methods in org.finra.herd.tools.retention.destroyer that return BusinessObjectDataKey

Modifier and Type	Method and Description
protected BusinessObjectDataKey	RetentionExpirationDestroyerController.getBusinessObjectDataKey(String[] line, int lineNumber, File inputCsvFile) Extracts business object data key from a CSV file line.

Methods in org.finra.herd.tools.retention.destroyer that return types with arguments of type BusinessObjectDataKey

Modifier and Type	Method and Description
protected List<BusinessObjectDataKey>	RetentionExpirationDestroyerController.getBusinessObjectDataKeys(File inputCsvFile) Get business object data keys from the input CSV tile.

Methods in org.finra.herd.tools.retention.destroyer with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectData	RetentionExpirationDestroyerWebClient.destroyBusinessObjectData(BusinessObjectDataKey businessObjectDataKey) Retrieves business object definition from the herd registration server.

Uses of BusinessObjectDataKey in org.finra.herd.tools.uploader

Methods in org.finra.herd.tools.uploader with parameters of type BusinessObjectDataKey

Modifier and Type	Method and Description
BusinessObjectDataVersions	UploaderWebClient.getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey) Retrieves all versions for the specified business object data key.
void	UploaderWebClient.updateBusinessObjectDataStatusIgnoreException(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Updates the business object data status.