OSID - osid.workflow.WorkflowSession Service Interface Definition

Interface	osid.workflow.WorkflowSession
Implements	`osid.OsidSession`
Description	This session provides methods for looking at a workflow.
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	canAccessWorkflow
Description	Tests if this user can access a workflow. 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 workflow operations to unauthorized users.
Return	`boolean`		`false` if workflow initiation methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAccessWorkflowForProcess
Description	Tests if this user can access a workflow in a process. 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 workflow operations to unauthorized users.
Parameters	`osid.id.Id`	`processId`	a process Id
Return	`boolean`		`false` if workflow initiation methods are not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`processId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessesForWork
Description	Gets the processes a work is in.
Parameters	`osid.id.Id`	`workId`	a work `Id`
Return	`osid.workflow.ProcessList`		the `Processes`
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStepForWork
Description	Gets the step corresponding to a work in a process.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Parameters	`osid.id.Id`	`workId`	a work `Id`
Return	`osid.workflow.Step`		the returned `Step`
Errors	NOT_FOUND		`processId` not found or `workId` is not active in the process
	NULL_ARGUMENT		`processId` or `workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorkAtStep
Description	Getsall the work at a step in a process.
Parameters	`osid.id.Id`	`stepId`	a step `Id`
Return	`osid.workflow.WorkList`		the returned `Work` List
Errors	NOT_FOUND		`stepId` is not found
	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSuspendedWork
Description	Gets all the suspended work in a process.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Return	`osid.workflow.WorkList`		the returned `Work` List
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSuspendedWorkAtStep
Description	Gets the suspended work at a step in a process.
Parameters	`osid.id.Id`	`stepId`	a step `Id`
Return	`osid.workflow.WorkList`		the returned `Work` List
Errors	NOT_FOUND		`stepId` is not found
	NULL_ARGUMENT		`stepId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanceledWork
Description	Gets the work canceled in a process.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Return	`osid.workflow.WorkList`		the returned `Work` List
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCanceledWorkByDate
Description	Gets the work canceled in a process within the given date range inclusive.
Parameters	`osid.id.Id`	`processId`	a process `Id`
	`osid.calendaring.DateTime`	`start`	start range
	`osid.calendaring.DateTime`	`end`	end range
Return	`osid.workflow.WorkList`		the returned `Work` List
Errors	INVALID_ARGUMENT		`start` is greater than `end`
	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId, start` or `end` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatusesForWork
Description	Gets the statuses of the work across all processes.
Parameters	`osid.id.Id`	`workId`	a work `Id`
Return	`osid.workflow.WorkflowEventList`		the current list of statuses
Errors	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatusForWork
Description	Gets the status of a work in a process.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Parameters	`osid.id.Id`	`workId`	a work `Id`
Return	`osid.workflow.WorkflowEvent`		the status
Errors	NOT_FOUND		`processId` not found or `workId` is not active in the process
	NULL_ARGUMENT		`processId` or `workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatusesForWorks
Description	Gets the status of a works in a process.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Parameters	`osid.id.IdList`	`workIds`	a list of work `Ids`
Return	`osid.workflow.WorkflowEventList`		the current list of statuses
Errors	NULL_ARGUMENT		`processId` or `workIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.