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

Interface	osid.workflow.event.WorkflowEventManager
Implements	`osid.OsidManager`
Implements	`osid.workflow.event.WorkflowEventProfile`
Used By	`osid.workflow.WorkflowManager`
Description	The workflow.event manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `WorkflowEventLookupSession`: a session to retrieve workflow events `WorkflowEventQuerySession`: a session to query for workflow events `WorkflowEventSearchSession`: a session to search for workflow events `WorkflowEventAdminSession`: a session to create and delete workflow events `WorkflowEventNotificationSession`: a session to receive notifications pertaining to workflow event changes `WorkflowEventOfficeSession`: a session to look up workflow event office mappings `WorkflowEventOfficeAssignmentSession`: a session to manage workflow event to office mappings `WorkflowEventSmartOfficeSession`: a session to manage dynamic offices of workflow events
Method	getWorkflowEventLookupSession
Description	Gets the `OsidSession` associated with the workflow event lookup service.
Return	`osid.workflow.event.WorkflowEventLookupSession`		a `WorkflowEventLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWorkflowEventLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventLookup()` is `true`.
Method	getWorkflowEventLookupSessionForOffice
Description	Gets the `OsidSession` associated with the workflow event lookup service for the given office.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.event.WorkflowEventLookupSession`		a `WorkflowEventLookupSession`
Errors	NOT_FOUND		no `Office` found by the given `Id`
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventLookup()` and `supportsVisibleFederation()` are `true`
Method	getWorkflowEventQuerySession
Description	Gets the `OsidSession` associated with the workflow event query service.
Return	`osid.workflow.event.WorkflowEventQuerySession`		a `WorkflowEventQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWorkflowEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventQuery()` is `true`.
Method	getWorkflowEventQuerySessionForOffice
Description	Gets the `OsidSession` associated with the workflow event query service for the given office.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.event.WorkflowEventQuerySession`		a `WorkflowEventQuerySession`
Errors	NOT_FOUND		no office found by the given `Id`
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventQuery()` and `supportsVisibleFederation()` are `true`
Method	getWorkflowEventSearchSession
Description	Gets the `OsidSession` associated with the workflow event search service.
Return	`osid.workflow.event.WorkflowEventSearchSession`		a `WorkflowEventSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWorkflowEventSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventSearch()` is `true`.
Method	getWorkflowEventSearchSessionForOffice
Description	Gets the `OsidSession` associated with the workflow event search service for the given office.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.event.WorkflowEventSearchSession`		a `WorkflowEventSearchSession`
Errors	NOT_FOUND		no office found by the given `Id`
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventSearch()` and `supportsVisibleFederation()` are `true`
Method	getWorkflowEventAdminSession
Description	Gets the `OsidSession` associated with the workflow event administration service.
Return	`osid.workflow.event.WorkflowEventAdminSession`		a `WorkflowEventAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWorkflowEventAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventAdmin()` is `true`.
Method	getWorkflowEventAdminSessionForOffice
Description	Gets the `OsidSession` associated with the workflow event administration service for the given office.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.event.WorkflowEventAdminSession`		a `WorkflowEventAdminSession`
Errors	NOT_FOUND		no office found by the given `Id`
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventAdmin()` and `supportsVisibleFederation()` are `true`
Method	getWorkflowEventNotificationSession
Description	Gets the `OsidSession` associated with the workflow event notification service.
Parameters	`osid.workflow.event.WorkflowEventReceiver`	`workflowEventReceiver`	the notification callback
Return	`osid.workflow.event.WorkflowEventNotificationSession`		a `WorkflowEventNotificationSession`
Errors	NULL_ARGUMENT		`workflowEventReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventNotification()` is `true`.
Method	getWorkflowEventNotificationSessionForOffice
Description	Gets the `OsidSession` associated with the workflow event notification service for the given office.
Parameters	`osid.workflow.event.WorkflowEventReceiver`	`workflowEventReceiver`	the notification callback
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.event.WorkflowEventNotificationSession`		a `WorkflowEventNotificationSession`
Errors	NOT_FOUND		no office found by the given `Id`
	NULL_ARGUMENT		`workflowEventReceiver` or `officeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventNotification()` and `supportsVisibleFederation()` are `true`
Method	getWorkflowEventOfficeSession
Description	Gets the `OsidSession` to lookup workflow event/office mappings.
Return	`osid.workflow.event.WorkflowEventOfficeSession`		a `WorkflowEventOfficeSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWorkflowEventOffice()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventOffice()` is `true`.
Method	getWorkflowEventOfficeAssignmentSession
Description	Gets the `OsidSession` associated with assigning workflow events to offices.
Return	`osid.workflow.event.WorkflowEventOfficeAssignmentSession`		a `WorkflowEventOfficeAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWorkflowEventOfficeAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventOfficeAssignment()` is `true`.
Method	getWorkflowEventSmartOfficeSession
Description	Gets the `OsidSession` to manage workflow event smart offices.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.event.WorkflowEventSmartOfficeSession`		a `WorkflowEventSmartOfficeSession`
Errors	NOT_FOUND		no office found by the given `Id`
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWorkflowEventSmartOffice()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkflowEventSmartOffice()` is `true`.