org.finra.herd.dao

Interface BusinessObjectDataDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

BusinessObjectDataDaoImpl

public interface BusinessObjectDataDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataEntity	getBusinessObjectDataByAltKey(BusinessObjectDataKey businessObjectDataKey) Retrieves business object data by it's key.
BusinessObjectDataEntity	getBusinessObjectDataByAltKeyAndStatus(BusinessObjectDataKey businessObjectDataKey, String businessObjectDataStatus) Retrieves business object data by it's key.
List<BusinessObjectDataKey>	getBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity, Integer maxResults) Gets a list of keys for business object data registered under specified business object definition entity.
List<BusinessObjectDataKey>	getBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatEntity businessObjectFormatEntity, Integer maxResults) Gets a list of keys for business object data registered under specified business object format entity.
Long	getBusinessObjectDataCount(BusinessObjectFormatKey businessObjectFormatKey) Returns a number of business object data instances registered with this business object format.
List<BusinessObjectDataEntity>	getBusinessObjectDataEntities(BusinessObjectDataKey businessObjectDataKey) Retrieves business object data versions that match the specified business object data key with potentially missing business object format and/or data version values.
List<BusinessObjectDataEntity>	getBusinessObjectDataEntities(BusinessObjectFormatKey businessObjectFormatKey, List<List<String>> partitionFilters, Integer businessObjectDataVersion, String businessObjectDataStatus, String storageName) Retrieves a list of business object data entities per specified parameters.
List<BusinessObjectDataEntity>	getBusinessObjectDataEntitiesByPartitionValue(String partitionValue) Retrieves a list of business object data by their partition value.
Map<BusinessObjectDataEntity,StoragePolicyEntity>	getBusinessObjectDataEntitiesMatchingStoragePolicies(StoragePolicyPriorityLevel storagePolicyPriorityLevel, List<String> supportedBusinessObjectDataStatuses, int storagePolicyTransitionMaxAllowedAttempts, int startPosition, int maxResult) Retrieves a map of business object data entities to their corresponding storage policy entities, where the business object data status is supported by the storage policy feature and the business object data alternate key values match storage policy's filter and transition (not taking into account storage policy rules).
List<BusinessObjectDataEntity>	getBusinessObjectDataFromStorageOlderThan(StorageEntity storageEntity, int thresholdMinutes, List<String> businessObjectDataStatuses) Selects business object data having storage files associated with the specified storage and status.
Integer	getBusinessObjectDataLimitedCountBySearchKey(BusinessObjectDataSearchKey businessObjectDataSearchKey, Integer recordCountLimit) Retrieves business object data record count up to to the specified record limit as per business object data search key.
String	getBusinessObjectDataMaxPartitionValue(int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, String businessObjectDataStatus, List<String> storageNames, String storagePlatformType, String excludedStoragePlatformType, String upperBoundPartitionValue, String lowerBoundPartitionValue) Retrieves a maximum available partition value per specified parameters.
Integer	getBusinessObjectDataMaxVersion(BusinessObjectDataKey businessObjectDataKey) Gets a maximum available version of the specified business object data.
String	getBusinessObjectDataMinPartitionValue(int partitionColumnPosition, BusinessObjectFormatKey businessObjectFormatKey, Integer businessObjectDataVersion, String businessObjectDataStatus, List<String> storageNames, String storagePlatformType, String excludedStoragePlatformType) Retrieves a minimum available partition value per specified parameters.
List<BusinessObjectData>	searchBusinessObjectData(BusinessObjectDataSearchKey businessObjectDataSearchKey, Integer pageNum, Integer pageSize) Retrieves a list of business object data per specified business object data search key.

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

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

Method Detail

getBusinessObjectDataByAltKey

BusinessObjectDataEntity getBusinessObjectDataByAltKey(BusinessObjectDataKey businessObjectDataKey)

Retrieves business object data by it's key. If a format version isn't specified, the latest available format version (for this partition value) will be used. If a business object data version isn't specified, the latest data version is returned regardless of the business object data status.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the business object data

getBusinessObjectDataByAltKeyAndStatus

BusinessObjectDataEntity getBusinessObjectDataByAltKeyAndStatus(BusinessObjectDataKey businessObjectDataKey,
                                                                String businessObjectDataStatus)

Retrieves business object data by it's key. If a format version isn't specified, the latest available format version (for this partition value) will be used. If a business object data version isn't specified, the latest data version based on the specified business object data status is returned. When both business object data version and business object data status both are not specified, the latest data version for each set of partition values will be used regardless of the status.

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataStatus - the business object data status. This parameter is ignored when the business object data version is specified.

Returns:

the business object data

getBusinessObjectDataMaxVersion

Integer getBusinessObjectDataMaxVersion(BusinessObjectDataKey businessObjectDataKey)

Gets a maximum available version of the specified business object data.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the maximum available version of the specified business object data

getBusinessObjectDataMaxPartitionValue

String getBusinessObjectDataMaxPartitionValue(int partitionColumnPosition,
                                              BusinessObjectFormatKey businessObjectFormatKey,
                                              Integer businessObjectDataVersion,
                                              String businessObjectDataStatus,
                                              List<String> storageNames,
                                              String storagePlatformType,
                                              String excludedStoragePlatformType,
                                              String upperBoundPartitionValue,
                                              String lowerBoundPartitionValue)

Retrieves a maximum available partition value per specified parameters.

Parameters:

partitionColumnPosition - the partition column position (1-based numbering)

businessObjectFormatKey - the business object format key (case-insensitive). If a business object format version isn't specified, the latest available format version for each partition value will be used.

businessObjectDataVersion - the business object data version. If a business object data version isn't specified, the latest data version based on the specified business object data status will be used for each partition value.

businessObjectDataStatus - the business object data status. This parameter is ignored when the business object data version is specified.

storageNames - the optional list of storage names (case-insensitive)

storagePlatformType - the optional storage platform type, e.g. S3 for Hive DDL. It is ignored when the list of storages is not empty

excludedStoragePlatformType - the optional storage platform type to be excluded from search. It is ignored when the list of storages is not empty or the storage platform type is specified

upperBoundPartitionValue - the optional inclusive upper bound for the maximum available partition value

lowerBoundPartitionValue - the optional inclusive lower bound for the maximum available partition value

Returns:

the maximum available partition value

getBusinessObjectDataMinPartitionValue

String getBusinessObjectDataMinPartitionValue(int partitionColumnPosition,
                                              BusinessObjectFormatKey businessObjectFormatKey,
                                              Integer businessObjectDataVersion,
                                              String businessObjectDataStatus,
                                              List<String> storageNames,
                                              String storagePlatformType,
                                              String excludedStoragePlatformType)

Retrieves a minimum available partition value per specified parameters.

Parameters:

partitionColumnPosition - the partition column position (1-based numbering)

businessObjectFormatKey - the business object format key (case-insensitive). If a business object format version isn't specified, the latest available format version for each partition value will be used.

businessObjectDataVersion - the business object data version. If a business object data version isn't specified, the latest data version based on the specified business object data status will be used for each partition value.

businessObjectDataStatus - the business object data status. This parameter is ignored when the business object data version is specified.

storageNames - the optional list of storage names (case-insensitive)

storagePlatformType - the optional storage platform type, e.g. S3 for Hive DDL. It is ignored when the list of storages is not empty

excludedStoragePlatformType - the optional storage platform type to be excluded from search. It is ignored when the list of storages is not empty or the storage platform type is specified

Returns:

the maximum available partition value

getBusinessObjectDataCount

Long getBusinessObjectDataCount(BusinessObjectFormatKey businessObjectFormatKey)

Returns a number of business object data instances registered with this business object format.

Parameters:

businessObjectFormatKey - the business object format key

Returns:

the number of business object data instances registered with this business object format

getBusinessObjectDataEntities

List<BusinessObjectDataEntity> getBusinessObjectDataEntities(BusinessObjectDataKey businessObjectDataKey)

Retrieves business object data versions that match the specified business object data key with potentially missing business object format and/or data version values.

Parameters:

businessObjectDataKey - the business object data key with potentially missing business object format and/or data version values

Returns:

the business object data

getBusinessObjectDataEntities

List<BusinessObjectDataEntity> getBusinessObjectDataEntities(BusinessObjectFormatKey businessObjectFormatKey,
                                                             List<List<String>> partitionFilters,
                                                             Integer businessObjectDataVersion,
                                                             String businessObjectDataStatus,
                                                             String storageName)

Retrieves a list of business object data entities per specified parameters.

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive). If a business object format version isn't specified, the latest available format version for each partition value will be used.

partitionFilters - the list of partition filter to be used to select business object data instances. Each partition filter contains a list of primary and sub-partition values in the right order up to the maximum partition levels allowed by business object data registration - with partition values for the relative partitions not to be used for selection passed as nulls.

businessObjectDataVersion - the business object data version. If a business object data version isn't specified, the latest data version based on the specified business object data status is returned.

businessObjectDataStatus - the business object data status. This parameter is ignored when the business object data version is specified. When business object data version and business object data status both are not specified, the latest data version for each set of partition values will be used regardless of the status.

storageName - the name of the storage where the business object data storage unit is located (case-insensitive)

Returns:

the list of business object data entities sorted by partition values

getBusinessObjectDataFromStorageOlderThan

List<BusinessObjectDataEntity> getBusinessObjectDataFromStorageOlderThan(StorageEntity storageEntity,
                                                                         int thresholdMinutes,
                                                                         List<String> businessObjectDataStatuses)

Selects business object data having storage files associated with the specified storage and status. Only tbe business object data records that are older than threshold minutes will be selected.

Parameters:

storageEntity - the storage entity

thresholdMinutes - the expiration time in minutes

businessObjectDataStatuses - the list of business object data statuses

Returns:

the list of business object data entities sorted by created on timestamp

getBusinessObjectDataEntitiesMatchingStoragePolicies

Map<BusinessObjectDataEntity,StoragePolicyEntity> getBusinessObjectDataEntitiesMatchingStoragePolicies(StoragePolicyPriorityLevel storagePolicyPriorityLevel,
                                                                                                       List<String> supportedBusinessObjectDataStatuses,
                                                                                                       int storagePolicyTransitionMaxAllowedAttempts,
                                                                                                       int startPosition,
                                                                                                       int maxResult)

Retrieves a map of business object data entities to their corresponding storage policy entities, where the business object data status is supported by the storage policy feature and the business object data alternate key values match storage policy's filter and transition (not taking into account storage policy rules). The storage policy priority level identifies a particular storage policy priority that will be selected by the query. The returned map is ordered by the business object data "created on" timestamp, starting with the oldest business object data entity.

Parameters:

storagePolicyPriorityLevel - the storage policy priority level

supportedBusinessObjectDataStatuses - the list of business object data statuses that storage policies apply to (case-sensitive)

storagePolicyTransitionMaxAllowedAttempts - the maximum number of failed storage policy transition attempts before the relative storage unit gets excluded from being selected. 0 means the maximum is not set

startPosition - the position of the first result, numbered from 0

maxResult - the maximum number of results to retrieve

Returns:

the map of business object data entities to their corresponding storage policy entities

getBusinessObjectDataEntitiesByPartitionValue

List<BusinessObjectDataEntity> getBusinessObjectDataEntitiesByPartitionValue(String partitionValue)

Retrieves a list of business object data by their partition value.

Parameters:

partitionValue - The partition value

Returns:

A list of business object data entity

getBusinessObjectDataByBusinessObjectDefinition

List<BusinessObjectDataKey> getBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionEntity businessObjectDefinitionEntity,
                                                                            Integer maxResults)

Gets a list of keys for business object data registered under specified business object definition entity. The results are sorted by primary partition value descending, sub-partition values (if present) descending, and business object data version descending.

Parameters:

businessObjectDefinitionEntity - the business object definition entity

maxResults - the optional maximum number of results to return

Returns:

the list of business object data keys

getBusinessObjectDataByBusinessObjectFormat

List<BusinessObjectDataKey> getBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatEntity businessObjectFormatEntity,
                                                                        Integer maxResults)

Gets a list of keys for business object data registered under specified business object format entity.

Parameters:

businessObjectFormatEntity - the business object format entity

maxResults - optional maximum number of results to return

Returns:

the list of business object data keys

getBusinessObjectDataLimitedCountBySearchKey

Integer getBusinessObjectDataLimitedCountBySearchKey(BusinessObjectDataSearchKey businessObjectDataSearchKey,
                                                     Integer recordCountLimit)

Retrieves business object data record count up to to the specified record limit as per business object data search key.

Parameters:

businessObjectDataSearchKey - the business object data search key

recordCountLimit - the business object data record count limit

Returns:

the record count of business object data up to to the specified limit

searchBusinessObjectData

List<BusinessObjectData> searchBusinessObjectData(BusinessObjectDataSearchKey businessObjectDataSearchKey,
                                                  Integer pageNum,
                                                  Integer pageSize)

Retrieves a list of business object data per specified business object data search key.

Parameters:

businessObjectDataSearchKey - the business object data search key

pageNum - if pageNum parameter is specified, results contain the appropriate page specified. Page numbers are one-based - that is the first page number is one

pageSize - if pageSize parameter is specified, results contain that number of business object data (unless it is the end of the result set)

Returns:

the list of business object data