OSID - osid.workflow.StepSmartOfficeSession Service Interface Definition

Interface	osid.workflow.StepSmartOfficeSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `StepQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `Steps.` The step may be sequenced using the `StepSearchOrder` from this session. This `Office` has a default query that matches any step and a default search order that specifies no sequencing. The queries may be examined using a `StepQueryInspector.` The query may be modified by converting the inspector back to a `StepQuery.`
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	getStepQuery
Description	Gets a step query.
Return	`osid.workflow.StepQuery`		the step query
Compliance	`mandatory`		This method must be implemented.
Method	getStepSearchOrder
Description	Gets a step search order.
Return	`osid.workflow.StepSearchOrder`		the step search order
Compliance	`mandatory`		This method must be implemented.
Method	applyStepQuery
Description	Applies a step query to this office.
Parameters	`osid.workflow.StepQuery`	`stepQuery`	the step query
Errors	NULL_ARGUMENT		`stepQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectStepQuery
Description	Gets a step query inspector for this office.
Return	`osid.workflow.StepQueryInspector`		the step query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyStepSequencing
Description	Applies a step search order to this office.
Parameters	`osid.workflow.StepSearchOrder`	`stepSearchOrder`	the step search order
Errors	NULL_ARGUMENT		`stepSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`stepSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStepQueryFromInspector
Description	Gets a step query from an inspector.
Parameters	`osid.workflow.StepQueryInspector`	`stepQueryInspector`	a step query inspector
Return	`osid.workflow.StepQuery`		the step query
Errors	NULL_ARGUMENT		`stepQueryInspector` is `null`
Errors	UNSUPPORTED		`stepQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.