OSID - osid.subscription.PublisherNotificationSession Service Interface Definition

Interface	osid.subscription.PublisherNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Publisher` 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 `Publisher` object itself. Adding and removing subscriptions result in notifications available from the notification session for subscriptions.
Method	canRegisterForPublisherNotifications
Description	Tests if this user can register for `Publisher` 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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	reliablePublisherNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePublisherNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePublisherNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePublisherNotification
Description	Acknowledge a publisher notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPublishers
Description	Register for notifications of new publishers. `PublisherReceiver.newPublishers()` is invoked when a new `Publisher` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPublishers
Description	Registers for notification of updated publishers. `PublisherReceiver.changedPublishers()` is invoked when a publisher is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPublisher
Description	Registers for notification of an updated publisher. `PublisherReceiver.changedPublishers()` is invoked when the specified publisher is changed.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher` to monitor
Errors	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPublishers
Description	Registers for notification of deleted publishers. `PublisherReceiver.deletedPublishers()` is invoked when a publisher is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPublisher
Description	Registers for notification of a deleted publisher. `PublisherReceiver.deletedPublishers()` is invoked when the specified publisher is deleted.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher` to monitor
Errors	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPublisherHierarchy
Description	Registers for notification of an updated publisher hierarchy structure. `PublishergReceiver.changedChildOfPublishers()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPublisherHierarchyForAncestors
Description	Registers for notification of an updated publisher hierarchy structure. `PublisherReceiver.changedChildOfPublishers()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher` node to monitor
Errors	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPublisherHierarchyForDescendants
Description	Registers for notification of an updated publisher hierarchy structure. `PublisherReceiver.changedChildOfPublishers()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher` node to monitor
Errors	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.