org.finra.herd.dao

Interface BusinessObjectDataNotificationRegistrationDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

BusinessObjectDataNotificationRegistrationDaoImpl

public interface BusinessObjectDataNotificationRegistrationDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataNotificationRegistrationEntity	getBusinessObjectDataNotificationRegistrationByAltKey(NotificationRegistrationKey key) Retrieves a business object data notification registration entity by alternate key.
List<NotificationRegistrationKey>	getBusinessObjectDataNotificationRegistrationKeysByNamespace(String namespace) Retrieves a list of business object data notification registration keys defined for the specified business object data notification registration namespace.
List<NotificationRegistrationKey>	getBusinessObjectDataNotificationRegistrationKeysByNotificationFilter(BusinessObjectDataNotificationFilter businessObjectDataNotificationFilter) Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters.
List<BusinessObjectDataNotificationRegistrationEntity>	getBusinessObjectDataNotificationRegistrations(String notificationEventTypeCode, BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus, String notificationRegistrationStatus) Retrieves a list of business object data notification registration entities that match given input parameters.

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

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

Method Detail

getBusinessObjectDataNotificationRegistrationByAltKey

BusinessObjectDataNotificationRegistrationEntity getBusinessObjectDataNotificationRegistrationByAltKey(NotificationRegistrationKey key)

Retrieves a business object data notification registration entity by alternate key.

Parameters:

key - the business object data notification registration key (case-insensitive)

Returns:

the business object data notification registration entity

getBusinessObjectDataNotificationRegistrationKeysByNamespace

List<NotificationRegistrationKey> getBusinessObjectDataNotificationRegistrationKeysByNamespace(String namespace)

Retrieves a list of business object data notification registration keys defined for the specified business object data notification registration namespace.

Parameters:

namespace - the namespace of the business object data notification registration (case-insensitive)

Returns:

the list of business object data notification registration keys

getBusinessObjectDataNotificationRegistrationKeysByNotificationFilter

List<NotificationRegistrationKey> getBusinessObjectDataNotificationRegistrationKeysByNotificationFilter(BusinessObjectDataNotificationFilter businessObjectDataNotificationFilter)

Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters.

Parameters:

businessObjectDataNotificationFilter - the filter for the business object data notification. Only the following four filter parameters are used to match the business object data notification registrations:

• the namespace of the business object definition (required, case-insensitive)
• the name of the business object definition (required, case-insensitive)
• the usage of the business object format (optional, case-insensitive)
• the file type of the business object format (optional, case-insensitive)

Returns:

the list of business object data notification registration keys

getBusinessObjectDataNotificationRegistrations

List<BusinessObjectDataNotificationRegistrationEntity> getBusinessObjectDataNotificationRegistrations(String notificationEventTypeCode,
                                                                                                      BusinessObjectDataKey businessObjectDataKey,
                                                                                                      String newBusinessObjectDataStatus,
                                                                                                      String oldBusinessObjectDataStatus,
                                                                                                      String notificationRegistrationStatus)

Retrieves a list of business object data notification registration entities that match given input parameters.

Parameters:

notificationEventTypeCode - the notification event type code (case-insensitive)

businessObjectDataKey - the business object data key (case-insensitive)

newBusinessObjectDataStatus - the new business object data status (case-insensitive)

oldBusinessObjectDataStatus - the old (previous) business object data status (case-insensitive). This parameter will be null for business object data registration

notificationRegistrationStatus - the status of the notification registration (case-insensitive)

Returns:

the list of business object data notification entities