public interface EntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Entry
objects within a Dictionary.
This
session is intended for consumers needing to synchronize their state with
this service without the use of polling. Notifications are cancelled when
this session is closed.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeEntryNotification(Id notificationId)
Acknowledge an entry notification.
|
boolean |
canRegisterForEntryNotifications()
Tests if this user can register for
Entry
notifications. |
Dictionary |
getDictionary()
Gets the
Dictionary associated with this session. |
Id |
getDictionaryId()
Gets the
Dictionary Id associated with
this session. |
void |
registerForChangedEntries()
Regsiters for notification of updated entries.
|
void |
registerForChangedEntriesByKeyTypeAndValueType(Type keyType,
Type valueType)
Registers for notifications of an update to entries by key and value
type
. |
void |
registerForChangedEntry(Id entryId)
Registers for notifications of an update to an
Entry. |
void |
registerForDeletedEntries()
Registers for notification of deleted dictionaries.
|
void |
registerForDeletedEntriesByKeyTypeAndValueType(Type keyType,
Type valueTYpe)
Registers for notifications of a deleted entries by key and value
type.
|
void |
registerForDeletedEntry(Id entryId)
Registers for notifications of a deleted
Entry. |
void |
registerForNewEntries()
Registers for notifications of new entries.
|
void |
registerForNewEntriesByKeyTypeAndValueType(Type keyType,
Type valueType)
Registers for notifications of new entries by key and value types.
|
void |
reliableEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableEntryNotifications()
Unreliable notifications are desired.
|
void |
useFederatedDictionaryView()
Federates the view for methods in this session.
|
void |
useIsolatedDictionaryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDictionaryId()
Dictionary
Id
associated with
this session. Dictionary
Id
associated
with this sessionmandatory
- This method must be implemented. Dictionary getDictionary() throws OperationFailedException, PermissionDeniedException
Dictionary
associated with this session. Dictionary
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForEntryNotifications()
Entry
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedDictionaryView()
mandatory
- This method is must be implemented. void useIsolatedDictionaryView()
mandatory
- This method is must be implemented. void reliableEntryNotifications()
acknowledgEntryNotification()
.mandatory
- This method is must be implemented. void unreliableEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEntries() throws OperationFailedException, PermissionDeniedException
EntryReceiver.newEntries()
is invoked when a new Entry
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEntriesByKeyTypeAndValueType(Type keyType, Type valueType) throws OperationFailedException, PermissionDeniedException
EntryReceiver.newEntries()
is invoked when a new
Entry
is created.keyType
- the entry key typevalueType
- the entry key typeNullArgumentException
- keyType
or
valueType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntries() throws OperationFailedException, PermissionDeniedException
EntryReceiver.changedEntries()
is invoked when an Entry
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntriesByKeyTypeAndValueType(Type keyType, Type valueType) throws OperationFailedException, PermissionDeniedException
.
EntryReceiver.changedEntries()
is
invoked when the specified Entry
is changed.keyType
- the entry key typevalueType
- the entry key typeNullArgumentException
- keyType
or
valueType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntry(Id entryId) throws OperationFailedException, PermissionDeniedException
Entry.
EntryReceiver.changedEntries()
is invoked when the
specified Entry
is changed.entryId
- the entry Id
NullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEntries() throws OperationFailedException, PermissionDeniedException
EntryReceiver.deletedEntries()
is invoked when the specified
Entry
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEntriesByKeyTypeAndValueType(Type keyType, Type valueTYpe) throws OperationFailedException, PermissionDeniedException
EntryReceiver.deletedEntries()
is invoked when
the specified Entry
is removed from this dictionary.keyType
- the entry key typevalueTYpe
- the entry key typeNullArgumentException
- keyType or valueType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEntry(Id entryId) throws OperationFailedException, PermissionDeniedException
Entry.
EntryReceiver.deletedEntries()
is invoked when the specified
Entry
is removed from this dictionary.entryId
- the entry Id
NullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.