public interface QualifierNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Qualifier
objects in this Vault.
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.
The two views defined in this session correspond to the views in the
QualifierLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeQualifierNotification(Id notificationId)
Acknowledge a qualifier notification.
|
boolean |
canRegisterForQualifierNotifications()
Tests if this user can register for
Qualifier
notifications. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
registerForChangedQualifier(Id qualifierId)
Registers for notification of an updated qualifier.
|
void |
registerForChangedQualifierHierarchy()
Registers for notification of an updated qualifier hierarchy
structure.
|
void |
registerForChangedQualifierHierarchyForAncestors(Id qualifierId)
Registers for notification of an updated qualifier hierarchy
structure.
|
void |
registerForChangedQualifierHierarchyForDescendants(Id qualifierId)
Registers for notification of an updated qualifier hierarchy
structure.
|
void |
registerForChangedQualifiers()
Registers for notification of updated qualifiers.
|
void |
registerForDeletedQualifier(Id qualifierId)
Registers for notification of a deleted qualifier.
|
void |
registerForDeletedQualifiers()
Registers for notification of deleted qualifiers.
|
void |
registerForNewQualifiers()
Register for notifications of new qualifiers.
|
void |
reliableQualifierNotifications()
Reliable notifications are desired.
|
void |
unreliableQualifierNotifications()
Unreliable notifications are desired.
|
void |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session. Vault
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForQualifierNotifications()
Qualifier
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 useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. void reliableQualifierNotifications()
acknowledgeQualifierNotification()
.mandatory
- This method is must be implemented. void unreliableQualifierNotifications()
mandatory
- This method is must be implemented. void acknowledgeQualifierNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewQualifiers() throws OperationFailedException, PermissionDeniedException
QualifierReceiver.newQualifiers()
is invoked when a new
Qualifier
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQualifiers() throws OperationFailedException, PermissionDeniedException
QualifierReceiver.changedQualifiers()
is invoked when a
qualifier is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQualifier(Id qualifierId) throws OperationFailedException, PermissionDeniedException
QualifierReceiver.changedQualifiers()
is invoked when the
specified qualifier is changed.qualifierId
- the Id
of the Qualifier
to monitorNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQualifiers() throws OperationFailedException, PermissionDeniedException
QualifierReceiver.deletedQualifiers()
is invoked when a
qualifier is removed from this vault.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQualifier(Id qualifierId) throws OperationFailedException, PermissionDeniedException
QualifierReceiver.deletedQualifiers()
is invoked when the
specified qualifier is removed from this vault.qualifierId
- the Id
of the Qualifier
to monitorNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQualifierHierarchy() throws OperationFailedException, PermissionDeniedException
QualifierReceiver.changedChildOfQualfiers()
is invoked when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQualifierHierarchyForAncestors(Id qualifierId) throws OperationFailedException, PermissionDeniedException
QualifierReceiver.changedChildOfQualifiers()
is invoked when the specified node or any of its ancestors experiences
a change in its children.qualifierId
- the Id
of the Qualifier
node to monitorNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQualifierHierarchyForDescendants(Id qualifierId) throws OperationFailedException, PermissionDeniedException
QualifierReceiver.changedChildOfQualifiers()
is invoked when the specified node or any of its descendants
experiences a change in its children.qualifierId
- the Id
of the Qualifier
node to monitorNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.