OSID - osid.forum.PostNotificationSession Service Interface Definition

Interface	osid.forum.PostNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Post` 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 `Post` object itself. Adding and removing replies result in notifications available from the notification session for replies.
Method	getForumId
Description	Gets the `Forum` `Id` associated with this session.
Return	`osid.id.Id`		the `Forum Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getForum
Description	Gets the `Forum` associated with this session.
Return	`osid.forum.Forum`		the forum
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForPostNotifications
Description	Tests if this user can register for `Post` 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	useFederatedForumView
Description	Federates the view for methods in this session. A federated view will include posts in forums which are children of this forum in the forum hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedForumView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this forum only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliablePostNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePostNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePostNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePostNotification
Description	Acknowledge a post 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	registerForNewPosts
Description	Register for notifications of new posts. `PostReceiver.newPosts()` is invoked when a new `Post` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPostsForPoster
Description	Register for notifications of new posts for the given poster resource `Id.` `PostReceiver.newPosts()` is invoked when a new `Post` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPosts
Description	Registers for notification of updated posts. `PostReceiver.changedPosts()` is invoked when a post is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPostsForPoster
Description	Register for notifications of changed posts for the given poster resource `Id.` `PostReceiver.changedPosts()` is invoked when a `Post` for the given agent is updated.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPost
Description	Registers for notification of an updated post. `PostReceiver.changedPosts()` is invoked when the specified post is changed.
Parameters	`osid.id.Id`	`postId`	the `Id` of the `Post` to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPosts
Description	Registers for notification of deleted posts. `PostReceiver.deletedPosts()` is invoked when a post is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPostsForPoster
Description	Register for notifications of deleted posts for the given poster resource `Id.` `PostReceiver.deletedPosts()` is invoked when a `Post` for the given agent is removed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPost
Description	Registers for notification of a deleted post. `PostReceiver.deletedPosts()` is invoked when the specified post is deleted.
Parameters	`osid.id.Id`	`postId`	the `Id` of the `Post` to monitor
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.