org.finra.herd.service.helper

Class BusinessObjectFormatDaoHelper

java.lang.Object

org.finra.herd.service.helper.BusinessObjectFormatDaoHelper

@Component
public class BusinessObjectFormatDaoHelper
extends Object

Helper for business object format related operations which require DAO.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatDaoHelper()

Method Summary

Modifier and Type	Method and Description
String	getBusinessObjectFormatAttributeValueByName(String attributeName, BusinessObjectFormatEntity businessObjectFormatEntity, boolean attributeRequired, boolean attributeValueRequiredIfExists) Gets attribute value by name from the business object format entity while specifying whether the attribute is required and whether the attribute value is required.
BusinessObjectFormatEntity	getBusinessObjectFormatEntity(BusinessObjectFormatKey businessObjectFormatKey) Gets a business object format entity based on the alternate key and makes sure that it exists.
RetentionTypeEntity	getRecordRetentionTypeEntity(String retentionTypeCode) Gets record retention type entity form retention type code

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectFormatDaoHelper

public BusinessObjectFormatDaoHelper()

Method Detail

getBusinessObjectFormatAttributeValueByName

public String getBusinessObjectFormatAttributeValueByName(String attributeName,
                                                          BusinessObjectFormatEntity businessObjectFormatEntity,
                                                          boolean attributeRequired,
                                                          boolean attributeValueRequiredIfExists)

Gets attribute value by name from the business object format entity while specifying whether the attribute is required and whether the attribute value is required.

Parameters:

attributeName - the attribute name (case insensitive)

businessObjectFormatEntity - the storage entity

attributeRequired - specifies whether the attribute is mandatory (i.e. whether it has a value or not)

attributeValueRequiredIfExists - specifies whether the attribute value is mandatory (i.e. the attribute must exist and its value must also contain a value)

Returns:

the attribute value from the attribute with the attribute name

getBusinessObjectFormatEntity

public BusinessObjectFormatEntity getBusinessObjectFormatEntity(BusinessObjectFormatKey businessObjectFormatKey)
                                                         throws ObjectNotFoundException

Gets a business object format entity based on the alternate key and makes sure that it exists. If a format version isn't specified in the business object format alternate key, the latest available format version will be used.

Parameters:

businessObjectFormatKey - the business object format key

Returns:

the business object format entity

Throws:

ObjectNotFoundException - if the business object format entity doesn't exist

getRecordRetentionTypeEntity

public RetentionTypeEntity getRecordRetentionTypeEntity(String retentionTypeCode)

Gets record retention type entity form retention type code

Parameters:

retentionTypeCode - retention type code

Returns:

the retention type entity