OSID - osid.process.ProcessManager Service Interface Definition

Interface	osid.process.ProcessManager
Implements	`osid.OsidManager`
Implements	`osid.process.ProcessProfile`
Description	The state manager provides access to state lookup and creation sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `StateSession:` a session to look up state to `Id` mappings `StateAssignmentSession:` a session to manage state to `Id` mappings `StateChangeNotificationSession:` a session to subscribe to state changes `StateLookupSession:` a session to retrieve states `StateQuerySession:` a session to query states `StateSearchSession:` a session to search for states `StateAdminSession:` a session to create and delete states `StateSequencingSession:` a session to sequence states `StateNotificationSession:` a session to receive notifications pertaining to state changes `ProcessLookupSession: a` session to retrieve processes `ProcessQuerySession:` a session to query processes `ProcessSearchSession:` a session to search for processes `ProcessAdminSession:` a session to create, update and delete processes `ProcessNotificationSession:` a session to receive notifications pertaining to changes in processes `ProcessHierarchySession:` a session to traverse process hierarchies `ProcessHierarchyDesignSession:` a session to manage process hierarchies
Method	getStateSession
Description	Gets the `OsidSession` associated with the state service.
Return	`osid.process.StateSession`		`a StateLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsState()` is `false`
Compliance	`optional`		This method must be implemented if `supportsState()` is `true.`
Method	getStateSessionForProcess
Description	Gets the `OsidSession` associated with the state service for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateSession`		`a StateStateSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsState()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsState()` and `supportsVisibleFederation()` are `true.`
Method	getStateAssignmentSession
Description	Gets the `OsidSession` associated with the state assignment service.
Return	`osid.process.StateAssignmentSession`		`a StateAssignmentLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStateAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateAssignment()` is `true.`
Method	getStateAssignmentSessionForProcess
Description	Gets the `OsidSession` associated with the state assignment service for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateAssignmentSession`		`a StateAssignmentStateSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsStateAssignment()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateAssignment()` and `supportsVisibleFederation()` are `true.`
Method	getStateChangeNotificationSession
Description	Gets the notification session for notifications pertaining to state changes.
Parameters	`osid.process.StateChangeReceiver`	`stateChangeReceiver`	the notification callback
Return	`osid.process.StateNotificationSession`		`a StateChangeNotificationSession`
Errors	NULL_ARGUMENT		`stateChangeReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStateChangeNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateChangeNotification()` is `true.`
Method	getStateChangeNotificationSessionForProcess
Description	Gets the state change notification session for the given process.
Parameters	`osid.process.StateChangeReceiver`	`stateChangeReceiver`	the notification callback
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateNotificationSession`		`a StateChangeNotificationSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`stateChangeReceiver` or `processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsStateChangeNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateChangeNotfication()` and `supportsVisibleFederation()` are `true.`
Method	getStateLookupSession
Description	Gets the `OsidSession` associated with the state lookup service.
Return	`osid.process.StateLookupSession`		`a StateLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStateLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateLookup()` is `true.`
Method	getStateLookupSessionForProcess
Description	Gets the `OsidSession` associated with the state lookup service for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateLookupSession`		`a StateLookupSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsStateLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateLookup()` and `supportsVisibleFederation()` are `true.`
Method	getStateQuerySession
Description	Gets a state query session.
Return	`osid.process.StateQuerySession`		`a StatQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStateQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateQuery()` is `true.`
Method	getStateQuerySessionForProcess
Description	Gets a state query session for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateQuerySession`		`a StateQuerySession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsStateQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateQuery()` and `supportsVisibleFederation()` are `true.`
Method	getStateSearchSession
Description	Gets a state search session.
Return	`osid.process.StateSearchSession`		`a StateSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStateSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateSearch()` is `true.`
Method	getStateSearchSessionForProcess
Description	Gets a state search session for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateSearchSession`		`a StateSearchSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsStateSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateSearch()` and `supportsVisibleFederation()` are `true.`
Method	getStateAdminSession
Description	Gets a state administration session for creating, updating and deleting states.
Return	`osid.process.StateAdminSession`		`a StateAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStateAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateAdmin()` is `true.`
Method	getStateAdminSessionForProcess
Description	Gets a state administration session for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateAdminSession`		`a StateAdminSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStateAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getStateSequencingSession
Description	Gets a state sequencing session for ordering states.
Return	`osid.process.StateSequencingSession`		`a StateSequencingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStateSequencing()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateSequencing()` is `true.`
Method	getStateSequencingSessionForProcess
Description	Gets a state sequencing session for the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateSequencingSession`		`a StateSequencingSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStateSequencing()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateSequencing()` and `supportsVisibleFederation()` are `true.`
Method	getStateNotificationSession
Description	Gets the notification session for notifications pertaining to state changes.
Parameters	`osid.process.StateReceiver`	`stateReceiver`	the notification callback
Return	`osid.process.StateNotificationSession`		`a StateNotificationSession`
Errors	NULL_ARGUMENT		`stateReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStateNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateNotification()` is `true.`
Method	getStateNotificationSessionForProcess
Description	Gets the state notification session for the given process.
Parameters	`osid.process.StateReceiver`	`stateReceiver`	the notification callback
Parameters	`osid.id.Id`	`processId`	the `Id` of the process
Return	`osid.process.StateNotificationSession`		`a StateNotificationSession`
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`stateReceiver` or `processId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsStateNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStateNotfication()` and `supportsVisibleFederation()` are `true.`
Method	getProcessLookupSession
Description	Gets the process lookup session.
Return	`osid.process.ProcessLookupSession`		a `ProcessLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProcessLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessLookup()` is `true.`
Method	getProcessQuerySession
Description	Gets the process query session.
Return	`osid.process.ProcessQuerySession`		a `ProcessQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProcessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessQuery()` is `true.`
Method	getProcessSearchSession
Description	Gets the process search session.
Return	`osid.process.ProcessSearchSession`		a `ProcessSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProcessSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessSearch()` is `true.`
Method	getProcessAdminSession
Description	Gets the process administrative session for creating, updating and deleteing processes.
Return	`osid.process.ProcessAdminSession`		a `ProcessAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProcessAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessAdmin()` is `true.`
Method	getProcessNotificationSession
Description	Gets the notification session for subscriprocessg to changes to a process.
Parameters	`osid.process.ProcessReceiver`	`processReceiver`	the notification callback
Return	`osid.process.ProcessNotificationSession`		a `ProcessNotificationSession`
Errors	NULL_ARGUMENT		`processReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProcessNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessNotification()` is `true.`
Method	getProcessHierarchySession
Description	Gets the process hierarchy traversal session.
Return	`osid.process.ProcessHierarchySession`		`a ProcessHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProcessHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessHierarchy()` is `true.`
Method	getProcessHierarchyDesignSession
Description	Gets the process hierarchy design session.
Return	`osid.process.ProcessHierarchyDesignSession`		a `ProcessHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProcessHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcessHierarchyDesign()` is `true.`