public interface DictionaryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Dictionary
objects. 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 |
---|---|
boolean |
canRegisterForDictionaryNotifications()
Tests if this user can register for
Dictionary
notifications. |
void |
registerForChangedDictionaries()
Registers for notification of updated dictionaries.
|
void |
registerForChangedDictionary(Id dictionaryId)
Registers for notification of an updated dictionary.
|
void |
registerForDeletedDictionaries()
Registers for notification of deleted dictionaries.
|
void |
registerForDeletedDictionary(Id dictionaryId)
Registers for notification of a deleted dictionary.
|
void |
registerForDeletedDictionaryAncestors(Id dictionaryId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified dictionary.
|
void |
registerForDeletedDictionaryDescendants(Id dictionaryId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified dictionary.
|
void |
registerForNewDictionaries()
Register for notifications of new dictionaries.
|
void |
registerForNewDictionaryAncestors(Id dictionaryId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified dictionary.
|
void |
registerForNewDictionaryDescendants(Id dictionaryId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified dictionary.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForDictionaryNotifications()
Dictionary
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 registerForNewDictionaries() throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.newDictionary()
is invoked when a new
Dictionary
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewDictionaryAncestors(Id dictionaryId) throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.newAncestorDictionary()
is invoked when the
specified dictionary node gets a new ancestor.dictionaryId
- the Id
of the Dictionary
node to monitorNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewDictionaryDescendants(Id dictionaryId) throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.newDescendantDictionary()
is invoked when
the specified dictionary node gets a new descendant.dictionaryId
- the Id
of the Dictionary
node to monitorNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDictionaries() throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.changedDictionary()
is invoked when a
dictionary is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDictionary(Id dictionaryId) throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.changedDictionary()
is invoked when the
specified dictionary is changed. A notification may be triggered for
any updated, deleted or new dictionary the specified dictionary
inherits data from.dictionaryId
- the Id
of the Dictionary
to monitorNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDictionaries() throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.deletedDictionary()
is invoked when a
dictionary is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDictionary(Id dictionaryId) throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.changedDictionary()
is invoked when the
specified dictionary is changed.dictionaryId
- the Id
of the Dictionary
to monitorNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDictionaryAncestors(Id dictionaryId) throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.deletedAncestor()
is invoked when the
specified dictionary node loses an ancestor.dictionaryId
- the Id
of the Dictionary
to monitorNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDictionaryDescendants(Id dictionaryId) throws OperationFailedException, PermissionDeniedException
DictionaryReceiver.deletedDescendant()
is invoked when the
specified dictionary node loses a descendant.dictionaryId
- the Id
of the Dictionary
to monitorNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.