OSID - osid.workflow.OfficeNotificationSession Service Interface Definition

Interface	osid.workflow.OfficeNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Office` 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.
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	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	registerForNewOfficeAncestors
Description	Registers for notification if an ancestor is added to the specified office in the office hierarchy. `OfficeReceiver.newOfficeAncestor()` is invoked when the specified office experiences an addition in ancestry.
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	registerForNewOfficeDescendants
Description	Registers for notification if a descendant is added to the specified office in the office hierarchy. `OfficeReceiver.newOfficeDescendant()` is invoked when the specified office experiences an addition in descendants.
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	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	registerForDeletedOfficeAncestors
Description	Registers for notification if an ancestor is removed from the specified office in the office hierarchy. `OfficeReceiver.deletedOfficeAncestor()` is invoked when the specified office experiences a removal of an ancestor.
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	registerForDeletedOfficeDescendants
Description	Registers for notification if a descendant is removed from fthe specified office in the office hierarchy. `OfficeReceiver.deletedOfficeDescednant()` is invoked when the specified office experiences a removal of one of its descdendents.
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.