OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Dispatch 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.

Notifications are triggered with changes to the Dispatch object itself. Adding and removing subscriptions result in notifications available from the notification session for subscriptions.

MethodgetPublisherId
Description

Gets the Publisher Id associated with this session.

Returnosid.id.Idthe Publisher Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPublisher
Description

Gets the Publisher associated with this session.

Returnosid.subscription.Publisherthe publisher
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForDispatchNotifications
Description

Tests if this user can register for Dispatch 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedPublisherView
Description

Federates the view for methods in this session. A federated view will include dispatches in publishers which are children of this publisher in the publisher hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPublisherView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only.

CompliancemandatoryThis method is must be implemented.
MethodreliableDispatchNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeDispatchNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableDispatchNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeDispatchNotification
Description

Acknowledge a dispatch notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewDispatches
Description

Register for notifications of new dispatches. DispatchReceiver.newDispatches() is invoked when a new Dispatch is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedDispatches
Description

Registers for notification of updated dispatches. DispatchReceiver.changedDispatches() is invoked when a dispatch is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedDispatch
Description

Registers for notification of an updated dispatch. DispatchReceiver.changedDispatches() is invoked when the specified dispatch is changed.

Parametersosid.id.IddispatchIdthe Id of the Dispatch to monitor
ErrorsNULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDispatches
Description

Registers for notification of deleted dispatches. DispatchReceiver.deletedDispatches() is invoked when a dispatch is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDispatch
Description

Registers for notification of a deleted dispatch. DispatchReceiver.deletedDispatches() is invoked when the specified dispatch is deleted.

Parametersosid.id.IddispatchIdthe Id of the Dispatch to monitor
ErrorsNULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.