OSID - osid.workflow.event.WorkflowEventNotificationSession Service Interface Definition

Interface	osid.workflow.event.WorkflowEventNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.event.WorkflowEventManager`
Used By	`osid.workflow.event.WorkflowEventProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `WorkflowEvents` in this `Office` . This also includes existing workflow events that may appear or disappear due to changes in the `Office hierarc` hy, 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. The two views defined in this session correspond to the views in the `WorkflowEventLookupSession` .
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForWorkflowEventNotifications
Description	Tests if this user can register for `WorkflowEvent` 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	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include workflow events in offices which are children of this office in the office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this office only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableWorkflowEventNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeWorkflowEventNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableWorkflowEventNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeWorkflowEventNotification
Description	Acknowledge a workflow event 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	registerForNewWorkflowEvents
Description	Register for notifications of new workflow events. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForProcess
Description	Register for notifications of new workflow events for the given process. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process` to monitor
Errors	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForStep
Description	Register for notifications of new workflow events for the given step. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step` to monitor
Errors	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForWork
Description	Register for notifications of new workflow events for the given work. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
Parameters	`osid.id.Id`	`workId`	the `Id` of the `Work` to monitor
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewWorkflowEventsForWorker
Description	Register for notifications of new workflow events for the given resource. `WorkflowEventReceiver.newWorkflowEvents()` is invoked when a new `WorkflowEvent` appears in this process.
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	registerForChangedWorkflowEvents
Description	Register for notifications of updated workflow events. `WorkflowEventReceiver.changedWorkflowEvents()` is invoked when a `WorkflowEvent` in this office is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWorkflowEventsForProcess
Description	Register for notifications of updated workflow events for the given process. `WorkflowEventReceiver.changedWorkflowEvents()` is invoked when a `WorkflowEvent` in this office is changed.
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process` to monitor
Errors	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWorkflowEventsForStep
Description	Register for notifications of updated workflow events for the given step. WorkflowEventReceiver.changedWorkflowEvents() is invoked when a WorkflowEvent in this office is changed.
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step` to monitor
Errors	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWorkflowEventsForWork
Description	Register for notifications of updated workflow events for the given work. WorkflowEventReceiver.changedWorkflowEvents() is invoked when a WorkflowEvent in this office is changed.
Parameters	`osid.id.Id`	`workId`	the `Id` of the `Work` to monitor
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWorkflowEventsForWorker
Description	Register for notifications of updated workflow events for the given resource. WorkflowEventReceiver.changedWorkflowEvents() is invoked when a WorkflowEvent in this office is changed.
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	registerForChangedWorkflowEvent
Description	Register for notifications of an updated workflow event. `WorkflowEventReceiver.changedWorkflowEvents()` is invoked when the specified `WorkflowEvent` in this office is changed.
Parameters	`osid.id.Id`	`workflowEventId`	the `Id` of the `WorkflowEvent` to monitor
Errors	NULL_ARGUMENT		`workflowEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWorkflowEvents
Description	Registers for notification of deleted workflow events. `WorkflowEventReceiver.deletedWorkflowEvents()` is invoked when a workflow event is deleted or removed from this office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWorkflowEventsForProcess
Description	Registers for notification of deleted workflow events for the given process. `WorkflowEventReceiver.deletedWorkflowEvents()` is invoked when a workflow event is deleted or removed from this office.
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process` to monitor
Errors	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWorkflowEventsForStep
Description	Registers for notification of deleted workflow events for the given step. `WorkflowEventReceiver.deletedWorkflowEvents()` is invoked when a workflow event is deleted or removed from this office.
Parameters	`osid.id.Id`	`stepId`	the `Id` of the `Step` to monitor
Errors	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWorkflowEventsForWork
Description	Registers for notification of deleted workflow events for the given work. `WorkflowEventReceiver.deletedWorkflowEvents()` is invoked when a workflow event is deleted or removed from this office.
Parameters	`osid.id.Id`	`workId`	the `Id` of the `Work` to monitor
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWorkflowEventsForWorker
Description	Registers for notification of deleted workflow events for the given resource. `WorkflowEventReceiver.deletedWorkflowEvents()` is invoked when a workflow event is deleted or removed from this office.
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	registerForDeletedWorkflowEvent
Description	Registers for notification of a deleted workflow event. `WorkflowEventReceiver.deletedWorkflowEvents()` is invoked when the specified workflow event is deleted or removed from this office.
Parameters	`osid.id.Id`	`workflowEventId`	the `Id` of the `WorkflowEvent` to monitor
Errors	NULL_ARGUMENT		`workflowEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.