public interface InquiryEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to InquiryEnabler
objects in this Inquest.
This also includes existing InquiryEnablers
that may appear
or disappear due to changes in the Inquest
hierarchy, 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
InquiryEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeInquiryEnablerNotification(Id notificationId)
Acknowledge an inquiru enabler notification.
|
boolean |
canRegisterForInquiryEnablerNotifications()
Tests if this user can register for
InquiryEnabler
notifications. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
registerForChangedInquiryEnabler(Id inquiryEnablerId)
Registers for notification of an updated inquiry enabler.
|
void |
registerForChangedInquiryEnablers()
Registers for notification of updated inquiry enablers.
|
void |
registerForDeletedInquiryEnabler(Id inquiryEnablerId)
Registers for notification of a deleted inquiry enabler.
|
void |
registerForDeletedInquiryEnablers()
Registers for notification of deleted inquiry enablers.
|
void |
registerForNewInquiryEnablers()
Register for notifications of new inquiry enablers.
|
void |
reliableInquiryEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableInquiryEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForInquiryEnablerNotifications()
InquiryEnabler
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 useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. void reliableInquiryEnablerNotifications()
acknowledgeInquiryEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableInquiryEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeInquiryEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewInquiryEnablers() throws OperationFailedException, PermissionDeniedException
InquiryEnablerReceiver.newInquiryEnablers()
is invoked when a
new InquiryEnabler
appears in this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquiryEnablers() throws OperationFailedException, PermissionDeniedException
InquiryEnablerReceiver.changedInquiryEnablers()
is invoked
when an inquiry enabler in this inquest is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquiryEnabler(Id inquiryEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedInquiryEnablers()
is invoked when
the specified inquiry enabler in this inquest is changed.inquiryEnablerId
- the Id
of the
InquiryEnabler
to monitorNullArgumentException
- inquiryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInquiryEnablers() throws OperationFailedException, PermissionDeniedException
InquiryEnablerReceiver.deletedInquiryEnablers()
is invoked
when an inquiry enabler is deleted or removed from this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInquiryEnabler(Id inquiryEnablerId) throws OperationFailedException, PermissionDeniedException
InquiryEnablerReceiver.deletedInquiryEnablers()
is invoked
when the specified inquiry enabler is deleted or removed from this
inquest.inquiryEnablerId
- the Id
of the
InquiryEnabler
to monitorNullArgumentException
- inquiryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.