org.finra.herd.service.helper

Class BusinessObjectFormatHelper

java.lang.Object

org.finra.herd.service.helper.BusinessObjectFormatHelper

@Component
public class BusinessObjectFormatHelper
extends Object

A helper class for BusinessObjectFormatService related code.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatHelper()

Method Summary

Modifier and Type	Method and Description
String	businessObjectFormatEntityAltKeyToString(BusinessObjectFormatEntity businessObjectFormatEntity) Returns a string representation of the alternate key values for the business object format.
String	businessObjectFormatKeyToString(BusinessObjectFormatKey businessObjectFormatKey) Returns a string representation of the business object format key.
BusinessObjectFormat	createBusinessObjectFormatFromEntity(BusinessObjectFormatEntity businessObjectFormatEntity) Creates the business object format from the persisted entity.
BusinessObjectFormat	createBusinessObjectFormatFromEntity(BusinessObjectFormatEntity businessObjectFormatEntity, Boolean checkLatestVersion) Creates the business object format from the persisted entity.
Map<String,BusinessObjectDataAttributeDefinitionEntity>	getAttributeDefinitionEntities(BusinessObjectFormatEntity businessObjectFormatEntity) Returns a map with attribute names in uppercase mapped to the relative attribute definition entities.
BusinessObjectFormatKey	getBusinessObjectFormatKey(BusinessObjectDataKey businessObjectDataKey) Gets business object format key from the specified business object data key.
BusinessObjectFormatKey	getBusinessObjectFormatKey(BusinessObjectFormat businessObjectFormat) Returns a business object format key for the business object format.
BusinessObjectFormatKey	getBusinessObjectFormatKey(BusinessObjectFormatEntity businessObjectFormatEntity) Creates a business object format key from specified business object format entity.
void	validateBusinessObjectFormatKey(BusinessObjectFormatKey key) Validates the business object format key.
void	validateBusinessObjectFormatKey(BusinessObjectFormatKey key, Boolean businessObjectFormatVersionRequired) Validates the business object format key.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectFormatHelper

public BusinessObjectFormatHelper()

Method Detail

businessObjectFormatEntityAltKeyToString

public String businessObjectFormatEntityAltKeyToString(BusinessObjectFormatEntity businessObjectFormatEntity)

Returns a string representation of the alternate key values for the business object format.

Parameters:

businessObjectFormatEntity - the business object format entity

Returns:

the string representation of the alternate key values for the business object format entity

businessObjectFormatKeyToString

public String businessObjectFormatKeyToString(BusinessObjectFormatKey businessObjectFormatKey)

Returns a string representation of the business object format key.

Parameters:

businessObjectFormatKey - the business object format key

Returns:

the string representation of the business object format key

createBusinessObjectFormatFromEntity

public BusinessObjectFormat createBusinessObjectFormatFromEntity(BusinessObjectFormatEntity businessObjectFormatEntity,
                                                                 Boolean checkLatestVersion)

Creates the business object format from the persisted entity.

Parameters:

businessObjectFormatEntity - the newly persisted business object format entity.

checkLatestVersion - need to check latest version

Returns:

the business object format.

createBusinessObjectFormatFromEntity

public BusinessObjectFormat createBusinessObjectFormatFromEntity(BusinessObjectFormatEntity businessObjectFormatEntity)

Creates the business object format from the persisted entity.

Parameters:

businessObjectFormatEntity - the newly persisted business object format entity.

Returns:

the business object format.

getAttributeDefinitionEntities

public Map<String,BusinessObjectDataAttributeDefinitionEntity> getAttributeDefinitionEntities(BusinessObjectFormatEntity businessObjectFormatEntity)

Returns a map with attribute names in uppercase mapped to the relative attribute definition entities.

Parameters:

businessObjectFormatEntity - the business object format entity

Returns:

the attribute definition entities loaded in a map

getBusinessObjectFormatKey

public BusinessObjectFormatKey getBusinessObjectFormatKey(BusinessObjectFormatEntity businessObjectFormatEntity)

Creates a business object format key from specified business object format entity.

Parameters:

businessObjectFormatEntity - the business object format entity

Returns:

the business object format key

getBusinessObjectFormatKey

public BusinessObjectFormatKey getBusinessObjectFormatKey(BusinessObjectFormat businessObjectFormat)

Returns a business object format key for the business object format.

Parameters:

businessObjectFormat - the business object format

Returns:

the business object format key

getBusinessObjectFormatKey

public BusinessObjectFormatKey getBusinessObjectFormatKey(BusinessObjectDataKey businessObjectDataKey)

Gets business object format key from the specified business object data key.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the business object format key

validateBusinessObjectFormatKey

public void validateBusinessObjectFormatKey(BusinessObjectFormatKey key)
                                     throws IllegalArgumentException

Validates the business object format key. This method also trims the key parameters.

Parameters:

key - the business object format key

Throws:

IllegalArgumentException - if any validation errors were found

validateBusinessObjectFormatKey

public void validateBusinessObjectFormatKey(BusinessObjectFormatKey key,
                                            Boolean businessObjectFormatVersionRequired)
                                     throws IllegalArgumentException

Validates the business object format key. This method also trims the key parameters.

Parameters:

key - the business object format key

businessObjectFormatVersionRequired - specifies if business object format version parameter is required or not

Throws:

IllegalArgumentException - if any validation errors were found