OSID - osid.workflow.OfficeNotificationSession Service Interface Definition

Interface	osid.workflow.OfficeNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Offices`. 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.
Method	canRegisterForOfficeNotifications
Description	Tests if this user can register for `Office` 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	reliableOfficeNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeOfficeNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableOfficeNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeOfficeNotification
Description	Acknowledge an office 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	registerForNewOffices
Description	Register for notifications of new offices. `OfficeReceiver.newOffices()` is invoked when a new `Office` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOffices
Description	Registers for notification of updated offices. `OfficeReceiver.changedOffices()` is invoked when an office is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOffice
Description	Registers for notification of an updated office. `OfficeReceiver.changedOffices()` is invoked when the specified office is changed.
Parameters	`osid.id.Id`	`officeId`	the Id of the `Office` to monitor
Errors	NULL_ARGUMENT		`officeId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOffices
Description	Registers for notification of deleted offices. `OfficeReceiver.deletedOffices()` is invoked when an office is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOffice
Description	Registers for notification of a deleted office. `OfficeReceiver.deletedOffices()` is invoked when the specified office is deleted.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office` to monitor
Errors	NULL_ARGUMENT		`officeId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOfficeHierarchy
Description	Registers for notification of an updated office hierarchy structure. `OfficeReceiver.changedChildOfOffices()` 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	registerForChangedOfficeHierarchyForAncestors
Description	Registers for notification of an updated office hierarchy structure. `OfficeReceiver.changedChildOfOffices()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office` node to monitor
Errors	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOfficeHierarchyForDescendants
Description	Registers for notification of an updated office hierarchy structure. `OfficeReceiver.changedChildOfOffices()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office` node to monitor
Errors	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.