org.finra.herd.service.helper

Class StorageUnitHelper

java.lang.Object

org.finra.herd.service.helper.StorageUnitHelper

@Component
public class StorageUnitHelper
extends Object

A helper class for storage unit related code.

Constructor Summary

Constructors

Constructor and Description
StorageUnitHelper()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataStorageUnitKey	createBusinessObjectDataStorageUnitKey(BusinessObjectDataKey businessObjectDataKey, String storageName) Creates a business object data storage unit key from business object data key and storage name.
BusinessObjectDataStorageUnitKey	createStorageUnitKey(BusinessObjectDataKey businessObjectDataKey, String storageName) Creates a storage unit key from a business object data key and a storage name.
BusinessObjectDataStorageUnitKey	createStorageUnitKeyFromEntity(StorageUnitEntity storageUnitEntity) Creates a storage unit key from a storage unit entity.
List<StorageUnit>	createStorageUnitsFromEntities(Collection<StorageUnitEntity> storageUnitEntities, Boolean includeStorageUnitStatusHistory) Creates a list of storage units from the list of storage unit entities.
List<StorageUnitAvailabilityDto>	excludeBusinessObjectDataStatus(List<StorageUnitAvailabilityDto> storageUnitAvailabilityDtos, String excludedBusinessObjectDataStatus) Excludes storage unit availability DTOs from the list with business object data status matching to the specified value.
List<StorageUnitAvailabilityDto>	excludePartitions(List<StorageUnitAvailabilityDto> storageUnitAvailabilityDtos, List<List<String>> excludedPartitions) Excludes storage unit availability DTOs from the list with primary and sub-partition values matching one of the excluded partitions.
BusinessObjectDataKey	getBusinessObjectDataKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey) Gets a business object data key from a storage unit key.
List<Integer>	getStorageUnitIds(List<StorageUnitAvailabilityDto> storageUnitAvailabilityDtos) Creates a list of storage unit ids from a list of storage unit availability DTOs.
void	validateBusinessObjectDataStorageUnitKey(BusinessObjectDataStorageUnitKey key) Validates the business object data storage unit key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageUnitHelper

public StorageUnitHelper()

Method Detail

createBusinessObjectDataStorageUnitKey

public BusinessObjectDataStorageUnitKey createBusinessObjectDataStorageUnitKey(BusinessObjectDataKey businessObjectDataKey,
                                                                               String storageName)

Creates a business object data storage unit key from business object data key and storage name.

Parameters:

businessObjectDataKey - the business object data key

storageName - the storage name

Returns:

the storage unit key

createStorageUnitKey

public BusinessObjectDataStorageUnitKey createStorageUnitKey(BusinessObjectDataKey businessObjectDataKey,
                                                             String storageName)

Creates a storage unit key from a business object data key and a storage name.

Parameters:

businessObjectDataKey - the business object data key

storageName - the storage name

Returns:

the storage unit key

createStorageUnitKeyFromEntity

public BusinessObjectDataStorageUnitKey createStorageUnitKeyFromEntity(StorageUnitEntity storageUnitEntity)

Creates a storage unit key from a storage unit entity.

Parameters:

storageUnitEntity - the storage unit entity

Returns:

the storage unit key

createStorageUnitsFromEntities

public List<StorageUnit> createStorageUnitsFromEntities(Collection<StorageUnitEntity> storageUnitEntities,
                                                        Boolean includeStorageUnitStatusHistory)

Creates a list of storage units from the list of storage unit entities.

Parameters:

storageUnitEntities - the storage unit entities.

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

Returns:

the list of storage units.

excludeBusinessObjectDataStatus

public List<StorageUnitAvailabilityDto> excludeBusinessObjectDataStatus(List<StorageUnitAvailabilityDto> storageUnitAvailabilityDtos,
                                                                        String excludedBusinessObjectDataStatus)

Excludes storage unit availability DTOs from the list with business object data status matching to the specified value.

Parameters:

storageUnitAvailabilityDtos - the list of storage unit availability DTOs

excludedBusinessObjectDataStatus - the business object data status to be excluded

Returns:

the updated list of storage unit availability DTOs

excludePartitions

public List<StorageUnitAvailabilityDto> excludePartitions(List<StorageUnitAvailabilityDto> storageUnitAvailabilityDtos,
                                                          List<List<String>> excludedPartitions)

Excludes storage unit availability DTOs from the list with primary and sub-partition values matching one of the excluded partitions.

Parameters:

storageUnitAvailabilityDtos - the list of storage unit availability DTOs

excludedPartitions - list of excluded partitions, where each partition consists of primary and optional sub-partition values

Returns:

the updated list of storage unit availability DTOs

getBusinessObjectDataKey

public BusinessObjectDataKey getBusinessObjectDataKey(BusinessObjectDataStorageUnitKey businessObjectDataStorageUnitKey)

Gets a business object data key from a storage unit key.

Parameters:

businessObjectDataStorageUnitKey - the storage unit key

Returns:

the business object data key

getStorageUnitIds

public List<Integer> getStorageUnitIds(List<StorageUnitAvailabilityDto> storageUnitAvailabilityDtos)

Creates a list of storage unit ids from a list of storage unit availability DTOs.

Parameters:

storageUnitAvailabilityDtos - the list of storage unit availability DTOs

Returns:

the list of storage unit ids

validateBusinessObjectDataStorageUnitKey

public void validateBusinessObjectDataStorageUnitKey(BusinessObjectDataStorageUnitKey key)

Validates the business object data storage unit key. This method also trims the request parameters.

Parameters:

key - the business object data storage unit create request