org.finra.herd.dao

Interface StorageUnitNotificationRegistrationDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

StorageUnitNotificationRegistrationDaoImpl

public interface StorageUnitNotificationRegistrationDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
StorageUnitNotificationRegistrationEntity	getStorageUnitNotificationRegistrationByAltKey(NotificationRegistrationKey key) Retrieves a storage unit notification registration entity by alternate key.
List<NotificationRegistrationKey>	getStorageUnitNotificationRegistrationKeysByNamespace(String namespace) Retrieves a list of storage unit notification registration keys defined for the specified storage unit notification registration namespace.
List<NotificationRegistrationKey>	getStorageUnitNotificationRegistrationKeysByNotificationFilter(StorageUnitNotificationFilter storageUnitNotificationFilter) Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.
List<StorageUnitNotificationRegistrationEntity>	getStorageUnitNotificationRegistrations(String notificationEventTypeCode, BusinessObjectDataKey businessObjectDataKey, String storageName, String newStorageUnitStatus, String oldStorageUnitStatus, String notificationRegistrationStatus) Retrieves a list of storage unit 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

getStorageUnitNotificationRegistrationByAltKey

StorageUnitNotificationRegistrationEntity getStorageUnitNotificationRegistrationByAltKey(NotificationRegistrationKey key)

Retrieves a storage unit notification registration entity by alternate key.

Parameters:

key - the storage unit notification registration key (case-insensitive)

Returns:

the storage unit notification registration entity

getStorageUnitNotificationRegistrationKeysByNamespace

List<NotificationRegistrationKey> getStorageUnitNotificationRegistrationKeysByNamespace(String namespace)

Retrieves a list of storage unit notification registration keys defined for the specified storage unit notification registration namespace.

Parameters:

namespace - the namespace of the storage unit notification registration (case-insensitive)

Returns:

the list of storage unit notification registration keys

getStorageUnitNotificationRegistrationKeysByNotificationFilter

List<NotificationRegistrationKey> getStorageUnitNotificationRegistrationKeysByNotificationFilter(StorageUnitNotificationFilter storageUnitNotificationFilter)

Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.

Parameters:

storageUnitNotificationFilter - the filter for the storage unit notification. Only the following four filter parameters are used to match the storage unit 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 storage unit notification registration keys

getStorageUnitNotificationRegistrations

List<StorageUnitNotificationRegistrationEntity> getStorageUnitNotificationRegistrations(String notificationEventTypeCode,
                                                                                        BusinessObjectDataKey businessObjectDataKey,
                                                                                        String storageName,
                                                                                        String newStorageUnitStatus,
                                                                                        String oldStorageUnitStatus,
                                                                                        String notificationRegistrationStatus)

Retrieves a list of storage unit 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)

storageName - the name of the storage (case-insensitive)

newStorageUnitStatus - the new storage unit status (case-insensitive)

oldStorageUnitStatus - the old (previous) storage unit status (case-insensitive). This parameter will be null for storage unit creation

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

Returns:

the list of storage unit notification registration entities