org.finra.herd.dao

Interface BusinessObjectFormatDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

BusinessObjectFormatDaoImpl

public interface BusinessObjectFormatDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormatEntity	getBusinessObjectFormatByAltKey(BusinessObjectFormatKey businessObjectFormatKey) Gets a business object format based on it's key.
Long	getBusinessObjectFormatCount(PartitionKeyGroupEntity partitionKeyGroupEntity) Returns a number of business object format instances that reference a specified partition key group.
Integer	getBusinessObjectFormatMaxVersion(BusinessObjectFormatKey businessObjectFormatKey) Gets the maximum available version of the specified business object format.
List<BusinessObjectFormatKey>	getBusinessObjectFormats(BusinessObjectDefinitionKey businessObjectDefinitionKey, boolean latestBusinessObjectFormatVersion) Gets a list of business object format keys for the specified business object definition key.

Methods inherited from interface org.finra.herd.dao.BaseJpaDao

delete, detach, findAll, findById, findByNamedProperties, findUniqueByNamedProperties, getCurrentTimestamp, getEntityManager, query, queryByNamedParams, save, saveAndRefresh

Method Detail

getBusinessObjectFormatByAltKey

BusinessObjectFormatEntity getBusinessObjectFormatByAltKey(BusinessObjectFormatKey businessObjectFormatKey)

Gets a business object format based on it's key. If a format version isn't specified, the latest available format version will be used.

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive)

Returns:

the business object format

getBusinessObjectFormatMaxVersion

Integer getBusinessObjectFormatMaxVersion(BusinessObjectFormatKey businessObjectFormatKey)

Gets the maximum available version of the specified business object format.

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive)

Returns:

the maximum available version of the specified business object format

getBusinessObjectFormatCount

Long getBusinessObjectFormatCount(PartitionKeyGroupEntity partitionKeyGroupEntity)

Returns a number of business object format instances that reference a specified partition key group.

Parameters:

partitionKeyGroupEntity - the partition key group entity

Returns:

the number of business object format instances that reference this partition key group

getBusinessObjectFormats

List<BusinessObjectFormatKey> getBusinessObjectFormats(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                       boolean latestBusinessObjectFormatVersion)

Gets a list of business object format keys for the specified business object definition key.

Parameters:

businessObjectDefinitionKey - the business object definition key

latestBusinessObjectFormatVersion - specifies if only the latest (maximum) versions of the relative business object formats are returned

Returns:

the list of business object format keys