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

Packages that use BusinessObjectData

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

Uses of BusinessObjectData in org.finra.herd.dao

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

Modifier and Type	Method and Description
List<BusinessObjectData>	BusinessObjectDataDao.searchBusinessObjectData(BusinessObjectDataSearchKey businessObjectDataSearchKey, Integer pageNum, Integer pageSize) Retrieves a list of business object data per specified business object data search key.

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

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

Modifier and Type	Method and Description
List<BusinessObjectData>	BusinessObjectDataDaoImpl.searchBusinessObjectData(BusinessObjectDataSearchKey businessObjectDataSearchKey, Integer pageNum, Integer pageSize)

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

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

Modifier and Type	Field and Description
protected BusinessObjectData	DownloadSingleInitiationResponse.businessObjectData
protected BusinessObjectData	UploadSingleInitiationResponse.sourceBusinessObjectData
protected BusinessObjectData	UploadSingleInitiationResponse.targetBusinessObjectData

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

Modifier and Type	Field and Description
protected List<BusinessObjectData>	BusinessObjectDataSearchResult.businessObjectDataElements
protected List<BusinessObjectData>	BusinessObjectDataInvalidateUnregisteredResponse.registeredBusinessObjectDataList

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

Modifier and Type	Method and Description
BusinessObjectData	ObjectFactory.createBusinessObjectData() Create an instance of BusinessObjectData
BusinessObjectData	DownloadSingleInitiationResponse.getBusinessObjectData() Gets the value of the businessObjectData property.
BusinessObjectData	UploadSingleInitiationResponse.getSourceBusinessObjectData() Gets the value of the sourceBusinessObjectData property.
BusinessObjectData	UploadSingleInitiationResponse.getTargetBusinessObjectData() Gets the value of the targetBusinessObjectData property.

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

Modifier and Type	Method and Description
List<BusinessObjectData>	BusinessObjectDataSearchResult.getBusinessObjectDataElements()
List<BusinessObjectData>	BusinessObjectDataInvalidateUnregisteredResponse.getRegisteredBusinessObjectDataList()

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

Modifier and Type	Method and Description
void	DownloadSingleInitiationResponse.setBusinessObjectData(BusinessObjectData value) Sets the value of the businessObjectData property.
void	UploadSingleInitiationResponse.setSourceBusinessObjectData(BusinessObjectData value) Sets the value of the sourceBusinessObjectData property.
void	UploadSingleInitiationResponse.setTargetBusinessObjectData(BusinessObjectData value) Sets the value of the targetBusinessObjectData property.

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

Modifier and Type	Method and Description
void	BusinessObjectDataSearchResult.setBusinessObjectDataElements(List<BusinessObjectData> businessObjectDataElements)
void	BusinessObjectDataInvalidateUnregisteredResponse.setRegisteredBusinessObjectDataList(List<BusinessObjectData> registeredBusinessObjectDataList)

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

Constructor and Description
DownloadSingleInitiationResponse(BusinessObjectData businessObjectData, String awsAccessKey, String awsSecretKey, String awsSessionToken, XMLGregorianCalendar awsSessionExpirationTime, String preSignedUrl) Fully-initialising value constructor
UploadSingleInitiationResponse(BusinessObjectData sourceBusinessObjectData, BusinessObjectData targetBusinessObjectData, File file, String uuid, String awsAccessKey, String awsSecretKey, String awsSessionToken, XMLGregorianCalendar awsSessionExpirationTime, String awsKmsKeyId, String targetStorageName) Fully-initialising value constructor

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

Constructor and Description
BusinessObjectDataInvalidateUnregisteredResponse(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, List<String> subPartitionValues, String storageName, List<BusinessObjectData> registeredBusinessObjectDataList) Fully-initialising value constructor
BusinessObjectDataSearchResult(List<BusinessObjectData> businessObjectDataElements) Fully-initialising value constructor

Uses of BusinessObjectData in org.finra.herd.rest

Methods in org.finra.herd.rest that return BusinessObjectData

Modifier and Type	Method and Description
BusinessObjectData	BusinessObjectDataRestController.createBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest) Creates (i.e.
BusinessObjectData	RelationalTableRegistrationRestController.createRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition) Creates relational table registration
BusinessObjectData	BusinessObjectDataRestController.deleteBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, Boolean deleteFiles) Deletes an existing business object data without subpartition values with namespace.
BusinessObjectData	BusinessObjectDataRestController.deleteBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, Integer businessObjectDataVersion, Boolean deleteFiles) Deletes an existing business object data with 1 subpartition value with namespace.
BusinessObjectData	BusinessObjectDataRestController.deleteBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, Integer businessObjectDataVersion, Boolean deleteFiles) Deletes an existing business object data with 2 subpartition values with namespace.
BusinessObjectData	BusinessObjectDataRestController.deleteBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, String subPartition3Value, Integer businessObjectDataVersion, Boolean deleteFiles) Deletes an existing business object data with 3 subpartition values with namespace
BusinessObjectData	BusinessObjectDataRestController.deleteBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, String subPartition3Value, String subPartition4Value, Integer businessObjectDataVersion, Boolean deleteFiles) Deletes an existing business object data with 4 subpartition values with namespace.
BusinessObjectData	BusinessObjectDataRestController.destroyBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String subPartitionValues) Initiates destruction process for an existing business object data.
BusinessObjectData	BusinessObjectDataRestController.getBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String businessObjectFormatPartitionKey, String partitionValue, String subPartitionValues, Integer businessObjectFormatVersion, Integer businessObjectDataVersion, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory) Retrieves existing business object data entry information.
BusinessObjectData	BusinessObjectDataRestController.restoreBusinessObjectData(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String subPartitionValues, Integer expirationInDays, String archiveRetrievalOption) Initiates a restore request for a currently archived business object data.
BusinessObjectData	BusinessObjectDataRestController.retryStoragePolicyTransition(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String subPartitionValues, 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	BusinessObjectDataRestController.updateBusinessObjectDataAttributes(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, BusinessObjectDataAttributesUpdateRequest request) Updates attributes for the business object data without subpartition values.
BusinessObjectData	BusinessObjectDataRestController.updateBusinessObjectDataAttributes(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, Integer businessObjectDataVersion, BusinessObjectDataAttributesUpdateRequest request) Updates attributes for the business object data with 1 subpartition value.
BusinessObjectData	BusinessObjectDataRestController.updateBusinessObjectDataAttributes(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, Integer businessObjectDataVersion, BusinessObjectDataAttributesUpdateRequest request) Updates attributes for the business object data with 2 subpartition values.
BusinessObjectData	BusinessObjectDataRestController.updateBusinessObjectDataAttributes(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, String subPartition3Value, Integer businessObjectDataVersion, BusinessObjectDataAttributesUpdateRequest request) Updates attributes for the business object data with 3 subpartition values.
BusinessObjectData	BusinessObjectDataRestController.updateBusinessObjectDataAttributes(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, String subPartition1Value, String subPartition2Value, String subPartition3Value, String subPartition4Value, Integer businessObjectDataVersion, BusinessObjectDataAttributesUpdateRequest request) Updates attributes for the business object data with 4 subpartition values.
BusinessObjectData	BusinessObjectDataRestController.updateBusinessObjectDataRetentionInformation(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String partitionValue, Integer businessObjectDataVersion, String subPartitionValues, BusinessObjectDataRetentionInformationUpdateRequest request) Updates retention information for an existing business object data.

Uses of BusinessObjectData in org.finra.herd.service

Methods in org.finra.herd.service that return BusinessObjectData

Modifier and Type	Method and Description
BusinessObjectData	BusinessObjectDataService.createBusinessObjectData(BusinessObjectDataCreateRequest businessObjectDataCreateRequest) Creates a new business object data from the request information.
BusinessObjectData	RelationalTableRegistrationService.createRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition) Creates a new relational table registration.
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	BusinessObjectDataInitiateDestroyHelperService.executeInitiateDestroyAfterStep(BusinessObjectDataDestroyDto businessObjectDataDestroyDto) Executes an after step for initiation of a business object data destroy.
BusinessObjectData	BusinessObjectDataInitiateRestoreHelperService.executeInitiateRestoreAfterStep(BusinessObjectDataRestoreDto businessObjectDataRestoreDto) Executes an after step for the initiation of a business object data restore request.
BusinessObjectData	BusinessObjectDataService.getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory) Retrieves existing business object data entry information.
BusinessObjectData	RelationalTableRegistrationService.processRelationalTableRegistrationForSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey) Updates relational table schema, if changes are detected, for an already existing relational table registration.
BusinessObjectData	RelationalTableRegistrationHelperService.registerRelationalTable(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, List<SchemaColumn> schemaColumns, Boolean appendToExistingBusinessObjectDefinition) Creates a new relational table registration.
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.
BusinessObjectData	RelationalTableRegistrationHelperService.updateRelationalTableSchema(RelationalTableRegistrationDto relationalTableRegistrationDto, List<SchemaColumn> schemaColumns) Updates relational table schema for an already existing relational table registration.

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

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

Modifier and Type	Method and Description
BusinessObjectData	BusinessObjectDataDaoHelper.createBusinessObjectData(BusinessObjectDataCreateRequest request) Creates a new business object data from the request information.
BusinessObjectData	BusinessObjectDataDaoHelper.createBusinessObjectData(BusinessObjectDataCreateRequest request, boolean fileSizeRequired) Creates a new business object data from the request information.
BusinessObjectData	BusinessObjectDataHelper.createBusinessObjectDataFromEntity(BusinessObjectDataEntity businessObjectDataEntity) Creates the business object data from the persisted entity.
BusinessObjectData	BusinessObjectDataHelper.createBusinessObjectDataFromEntity(BusinessObjectDataEntity businessObjectDataEntity, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory) Creates the business object data from the persisted entity.
BusinessObjectData	BusinessObjectDataRetryStoragePolicyTransitionHelper.retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetryStoragePolicyTransitionRequest request) Executes a retry of the storage policy transition and return the business object data information.

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

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.getBusinessObjectDataKey(BusinessObjectData businessObjectData) Returns a business object data key for the business object data.
List<String>	BusinessObjectDataHelper.getPrimaryAndSubPartitionValues(BusinessObjectData businessObjectData) Returns a list of primary and sub-partition values per specified business object data.
StorageUnit	BusinessObjectDataHelper.getStorageUnitByStorageName(BusinessObjectData businessObjectData, String storageName) Gets a storage unit by storage name (case insensitive).
void	BusinessObjectDataDaoHelper.triggerNotificationsForCreateBusinessObjectData(BusinessObjectData businessObjectData) Trigger business object data and storage unit notification for business object data creation event.

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

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

Modifier and Type	Method and Description
BusinessObjectData	BusinessObjectDataServiceImpl.createBusinessObjectData(BusinessObjectDataCreateRequest request)
BusinessObjectData	RelationalTableRegistrationServiceImpl.createRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition)
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	BusinessObjectDataInitiateDestroyHelperServiceImpl.executeInitiateDestroyAfterStep(BusinessObjectDataDestroyDto businessObjectDataDestroyDto) Executes an after step for initiation of a business object data destroy.
BusinessObjectData	BusinessObjectDataInitiateRestoreHelperServiceImpl.executeInitiateRestoreAfterStep(BusinessObjectDataRestoreDto businessObjectDataRestoreDto) Executes an after step for the initiation of a business object data restore request.
protected BusinessObjectData	BusinessObjectDataInitiateRestoreHelperServiceImpl.executeInitiateRestoreAfterStepImpl(BusinessObjectDataRestoreDto businessObjectDataRestoreDto) Executes an after step for the initiation of a business object data restore request.
BusinessObjectData	BusinessObjectDataServiceImpl.getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory)
BusinessObjectData	RelationalTableRegistrationServiceImpl.processRelationalTableRegistrationForSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey)
BusinessObjectData	RelationalTableRegistrationHelperServiceImpl.registerRelationalTable(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, List<SchemaColumn> schemaColumns, Boolean appendToExistingBusinessObjectDefinition)
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)
BusinessObjectData	BusinessObjectDataServiceImpl.updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest)
BusinessObjectData	BusinessObjectDataServiceImpl.updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest)
BusinessObjectData	RelationalTableRegistrationHelperServiceImpl.updateRelationalTableSchema(RelationalTableRegistrationDto relationalTableRegistrationDto, List<SchemaColumn> schemaColumns)

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

Methods in org.finra.herd.tools.common.databridge that return BusinessObjectData

Modifier and Type	Method and Description
protected BusinessObjectData	DataBridgeWebClient.getBusinessObjectData(org.apache.http.client.methods.CloseableHttpResponse httpResponse, String actionDescription) Extracts BusinessObjectData object from the registration server HTTP response.
BusinessObjectData	DataBridgeWebClient.preRegisterBusinessObjectData(UploaderInputManifestDto manifest, String storageName, Boolean createNewVersion) Pre-registers business object data with the registration server.

Uses of BusinessObjectData in org.finra.herd.tools.downloader

Methods in org.finra.herd.tools.downloader that return BusinessObjectData

Modifier and Type	Method and Description
BusinessObjectData	DownloaderWebClient.getBusinessObjectData(DownloaderInputManifestDto manifest) Retrieves business object data from the herd registration server.

Methods in org.finra.herd.tools.downloader with parameters of type BusinessObjectData

Modifier and Type	Method and Description
protected DownloaderOutputManifestDto	DownloaderController.createDownloaderOutputManifestDto(BusinessObjectData businessObjectData, StorageUnit storageUnit, String s3KeyPrefix) Creates a downloader output manifest instance from the business object data.
S3KeyPrefixInformation	DownloaderWebClient.getS3KeyPrefix(BusinessObjectData businessObjectData) Retrieves S3 key prefix from the herd registration server.

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

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

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