OSID - osid.workflow.ProcessSmartOfficeSession Service Interface Definition

Interface	osid.workflow.ProcessSmartOfficeSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.WorkflowManager`
Used By	`osid.workflow.WorkflowProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProcessQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `Processes`. The process may be sequenced using the `ProcessSearchOrder` from this session. This `Office` has a default query that matches any process and a default search order that specifies no sequencing. The queries may be examined using a `ProcessQueryInspector`. The query may be modified by converting the inspector back to a `ProcessQuery`.
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	canManageSmartOffices
Description	Tests if this user can manage smart offices. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart office management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessQuery
Description	Gets a process query.
Return	`osid.workflow.ProcessQuery`		the process query
Compliance	`mandatory`		This method must be implemented.
Method	getProcessSearchOrder
Description	Gets a process search order.
Return	`osid.workflow.ProcessSearchOrder`		the process search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessQuery
Description	Applies a process query to this office.
Parameters	`osid.workflow.ProcessQuery`	`processQuery`	the process query
Errors	NULL_ARGUMENT		`processQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProcessQuery
Description	Gets a process query inspector for this office.
Return	`osid.workflow.ProcessQueryInspector`		the process query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessSequencing
Description	Applies a process search order to this office.
Parameters	`osid.workflow.ProcessSearchOrder`	`processSearchOrder`	the process search order
Errors	NULL_ARGUMENT		`processSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessQueryFromInspector
Description	Gets a process query from an inspector.
Parameters	`osid.workflow.ProcessQueryInspector`	`processQueryInspector`	a process query inspector
Return	`osid.workflow.ProcessQuery`		the process query
Errors	NULL_ARGUMENT		`processQueryInspector` is `null`
Errors	UNSUPPORTED		`processQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.