OSID - osid.workflow.WorkSmartOfficeSession Service Interface Definition

Interface	osid.workflow.WorkSmartOfficeSession
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 `WorkQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `Works` . The works may be sequenced using the `WorkSearchOrder` from this session. This `Office` has a default query that matches any work and a default search order that specifies no sequencing. The queries may be examined using a `WorkQueryInspector` . The query may be modified by converting the inspector back to a `WorkQuery` .
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	getWorkQuery
Description	Gets a work query.
Return	`osid.workflow.WorkQuery`		the work query
Compliance	`mandatory`		This method must be implemented.
Method	getWorkSearchOrder
Description	Gets a work search order.
Return	`osid.workflow.WorkSearchOrder`		the work search order
Compliance	`mandatory`		This method must be implemented.
Method	applyWorkQuery
Description	Applies a work query to this office.
Parameters	`osid.workflow.WorkQuery`	`workQuery`	the work query
Errors	NULL_ARGUMENT		`workQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`workQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectWorkQuery
Description	Gets a work query inspector for this office.
Return	`osid.workflow.WorkQueryInspector`		the work query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyWorkSequencing
Description	Applies a work search order to this office.
Parameters	`osid.workflow.WorkSearchOrder`	`workSearchOrder`	the work search order
Errors	NULL_ARGUMENT		`workSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`workSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getWorkQueryFromInspector
Description	Gets a work query from an inspector.
Parameters	`osid.workflow.WorkQueryInspector`	`workQueryInspector`	a work query inspector
Return	`osid.workflow.WorkQuery`		the work query
Errors	NULL_ARGUMENT		`workQueryInspector` is `null`
Errors	UNSUPPORTED		`workQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.