org.finra.herd.service

Interface StorageUnitNotificationRegistrationService

All Known Implementing Classes:

StorageUnitNotificationRegistrationServiceImpl

public interface StorageUnitNotificationRegistrationService

The storage unit notification registration service.

Method Summary

Modifier and Type	Method and Description
StorageUnitNotificationRegistration	createStorageUnitNotificationRegistration(StorageUnitNotificationRegistrationCreateRequest request) Creates a new storage unit notification registration.
StorageUnitNotificationRegistration	deleteStorageUnitNotificationRegistration(NotificationRegistrationKey notificationRegistrationKey) Deletes an existing storage unit notification registration by key.
StorageUnitNotificationRegistration	getStorageUnitNotificationRegistration(NotificationRegistrationKey notificationRegistrationKey) Gets an existing storage unit notification by key.
StorageUnitNotificationRegistrationKeys	getStorageUnitNotificationRegistrationsByNamespace(String namespace) Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.
StorageUnitNotificationRegistrationKeys	getStorageUnitNotificationRegistrationsByNotificationFilter(StorageUnitNotificationFilter storageUnitNotificationFilter) Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter.
StorageUnitNotificationRegistration	updateStorageUnitNotificationRegistration(NotificationRegistrationKey notificationRegistrationKey, StorageUnitNotificationRegistrationUpdateRequest request) Updates an existing storage unit notification by key.

Method Detail

createStorageUnitNotificationRegistration

StorageUnitNotificationRegistration createStorageUnitNotificationRegistration(StorageUnitNotificationRegistrationCreateRequest request)

Creates a new storage unit notification registration.

Parameters:

request - the information needed to create a storage unit notification

Returns:

the newly created storage unit notification registration

deleteStorageUnitNotificationRegistration

StorageUnitNotificationRegistration deleteStorageUnitNotificationRegistration(NotificationRegistrationKey notificationRegistrationKey)

Deletes an existing storage unit notification registration by key.

Parameters:

notificationRegistrationKey - the storage unit notification registration key

Returns:

the storage unit notification registration that got deleted

getStorageUnitNotificationRegistration

StorageUnitNotificationRegistration getStorageUnitNotificationRegistration(NotificationRegistrationKey notificationRegistrationKey)

Gets an existing storage unit notification by key.

Parameters:

notificationRegistrationKey - the storage unit notification registration key

Returns:

the storage unit notification registration

getStorageUnitNotificationRegistrationsByNamespace

StorageUnitNotificationRegistrationKeys getStorageUnitNotificationRegistrationsByNamespace(String namespace)

Gets a list of keys for all existing storage unit notification registrations for the specified storage unit notification registration namespace.

Parameters:

namespace - the namespace of the storage unit notification registration

Returns:

the storage unit notification registration keys

getStorageUnitNotificationRegistrationsByNotificationFilter

StorageUnitNotificationRegistrationKeys getStorageUnitNotificationRegistrationsByNotificationFilter(StorageUnitNotificationFilter storageUnitNotificationFilter)

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

Parameters:

storageUnitNotificationFilter - the filter for the storage unit notification registration

Returns:

the storage unit notification registration keys

updateStorageUnitNotificationRegistration

StorageUnitNotificationRegistration updateStorageUnitNotificationRegistration(NotificationRegistrationKey notificationRegistrationKey,
                                                                              StorageUnitNotificationRegistrationUpdateRequest request)

Updates an existing storage unit notification by key.

Parameters:

notificationRegistrationKey - the storage unit notification registration key

Returns:

the storage unit notification registration that got updated