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	getBusinessObjectFormatCountByPartitionKeyGroup(PartitionKeyGroupEntity partitionKeyGroupEntity) Returns a number of business object format instances that reference a specified partition key group.
Long	getBusinessObjectFormatCountByPartitionKeys(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, List<String> partitionKeys) Retrieves business object format record count per specified parameters including an optional list of partition keys.
List<Long>	getBusinessObjectFormatIdsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity) Gets a list of ids for all business object formats registered under the specified business object definition.
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.
List<BusinessObjectFormatKey>	getBusinessObjectFormatsWithFilters(BusinessObjectDefinitionKey businessObjectDefinitionKey, String businessObjectFormatUsage, boolean latestBusinessObjectFormatVersion) Gets a list of business object format keys for the specified business object definition key and business object format usage.
List<BusinessObjectFormatEntity>	getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity) Gets a list of latest version business object format entities for the specified business object definition entity.

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

getBusinessObjectFormatCountByPartitionKeyGroup

Long getBusinessObjectFormatCountByPartitionKeyGroup(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

getBusinessObjectFormatCountByPartitionKeys

Long getBusinessObjectFormatCountByPartitionKeys(String namespace,
                                                 String businessObjectDefinitionName,
                                                 String businessObjectFormatUsage,
                                                 String businessObjectFormatFileType,
                                                 Integer businessObjectFormatVersion,
                                                 List<String> partitionKeys)

Retrieves business object format record count per specified parameters including an optional list of partition keys.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the usage of the business object format, maybe null

businessObjectFormatFileType - the file type of the business object format, maybe null

businessObjectFormatVersion - the version of the business object format, maybe null

partitionKeys - the list of partition keys, maybe null or empty

Returns:

the record count of business object formats

getBusinessObjectFormatIdsByBusinessObjectDefinition

List<Long> getBusinessObjectFormatIdsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity)

Gets a list of ids for all business object formats registered under the specified business object definition. The list of business object format ids returned by this method is sorted by business object format usage ascending, file type ascending, and business object format version descending.

Parameters:

businessObjectDefinitionEntity - the business object definition

Returns:

the list of business object format ids

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

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

getBusinessObjectFormatsWithFilters

List<BusinessObjectFormatKey> getBusinessObjectFormatsWithFilters(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                  String businessObjectFormatUsage,
                                                                  boolean latestBusinessObjectFormatVersion)

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

Parameters:

businessObjectDefinitionKey - the business object definition key

businessObjectFormatUsage - the business object format usage

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

Returns:

the list of business object format keys

getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition

List<BusinessObjectFormatEntity> getLatestVersionBusinessObjectFormatsByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity)

Gets a list of latest version business object format entities for the specified business object definition entity.

Parameters:

businessObjectDefinitionEntity - the business object definition entity

Returns:

the list of business object format entities