org.finra.herd.service

Interface BusinessObjectDataNotificationRegistrationService

All Known Implementing Classes:

BusinessObjectDataNotificationRegistrationServiceImpl

public interface BusinessObjectDataNotificationRegistrationService

The business object data notification service.

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataNotificationRegistration	createBusinessObjectDataNotificationRegistration(BusinessObjectDataNotificationRegistrationCreateRequest request) Creates a new business object data notification.
BusinessObjectDataNotificationRegistration	deleteBusinessObjectDataNotificationRegistration(NotificationRegistrationKey key) Deletes an existing business object data notification by key.
BusinessObjectDataNotificationRegistration	getBusinessObjectDataNotificationRegistration(NotificationRegistrationKey key) Gets an existing business object data notification by key.
BusinessObjectDataNotificationRegistrationKeys	getBusinessObjectDataNotificationRegistrationsByNamespace(String namespace) Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.
BusinessObjectDataNotificationRegistrationKeys	getBusinessObjectDataNotificationRegistrationsByNotificationFilter(BusinessObjectDataNotificationFilter businessObjectDataNotificationFilter) Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter.
BusinessObjectDataNotificationRegistration	updateBusinessObjectDataNotificationRegistration(NotificationRegistrationKey key, BusinessObjectDataNotificationRegistrationUpdateRequest request) Updates an existing business object data notification by key.

Method Detail

createBusinessObjectDataNotificationRegistration

BusinessObjectDataNotificationRegistration createBusinessObjectDataNotificationRegistration(BusinessObjectDataNotificationRegistrationCreateRequest request)

Creates a new business object data notification.

Parameters:

request - the information needed to create a business object data notification

Returns:

the newly created business object data notification

getBusinessObjectDataNotificationRegistration

BusinessObjectDataNotificationRegistration getBusinessObjectDataNotificationRegistration(NotificationRegistrationKey key)

Gets an existing business object data notification by key.

Parameters:

key - the business object data notification registration key

Returns:

the business object data notification information

updateBusinessObjectDataNotificationRegistration

BusinessObjectDataNotificationRegistration updateBusinessObjectDataNotificationRegistration(NotificationRegistrationKey key,
                                                                                            BusinessObjectDataNotificationRegistrationUpdateRequest request)

Updates an existing business object data notification by key.

Parameters:

key - the business object data notification registration key

Returns:

the business object data notification that got updated

deleteBusinessObjectDataNotificationRegistration

BusinessObjectDataNotificationRegistration deleteBusinessObjectDataNotificationRegistration(NotificationRegistrationKey key)

Deletes an existing business object data notification by key.

Parameters:

key - the business object data notification registration key

Returns:

the business object data notification that got deleted

getBusinessObjectDataNotificationRegistrationsByNamespace

BusinessObjectDataNotificationRegistrationKeys getBusinessObjectDataNotificationRegistrationsByNamespace(String namespace)

Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.

Parameters:

namespace - the namespace of the business object data notification registration

Returns:

the business object data notification registration keys

getBusinessObjectDataNotificationRegistrationsByNotificationFilter

BusinessObjectDataNotificationRegistrationKeys getBusinessObjectDataNotificationRegistrationsByNotificationFilter(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:

businessObjectDataNotificationFilter - the filter for the business object data notification

Returns:

the business object data notification registration keys