OSID - osid.workflow.rules.ProcessEnablerSmartOfficeSession Service Interface Definition

Interface	osid.workflow.rules.ProcessEnablerSmartOfficeSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic offices. A `ProcessEnablerQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of process enablers. The process enabler may be sequenced using the `ProcessEnablerSearchOrder` from this session. This `Office` has a default query that matches any process enabler and a default search order that specifies no sequencing. The queries may be examined using a `ProcessEnablerQueryInspector`. The query may be modified by converting the inspector back to a `ProcessEnablerQuery`.
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	getProcessEnablerQuery
Description	Gets a process enabler query.
Return	`osid.workflow.rules.ProcessEnablerQuery`		the process enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablerSearchOrder
Description	Gets a process enabler search order.
Return	`osid.workflow.rules.ProcessEnablerSearchOrder`		the process enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessEnablerQuery
Description	Applies a process enabler query to this office.
Parameters	`osid.workflow.rules.ProcessEnablerQuery`	`processEnablerQuery`	the process enabler query
Errors	NULL_ARGUMENT		`processEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProcessEnablerQuery
Description	Gets a process enabler query inspector for this office.
Return	`osid.workflow.rules.ProcessEnablerQueryInspector`		the process enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessEnablerSequencing
Description	Applies a process enabler search order to this office.
Parameters	`osid.workflow.rules.ProcessEnablerSearchOrder`	`processEnablerSearchOrder`	the process enabler search order
Errors	NULL_ARGUMENT		`processEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablerQueryFromInspector
Description	Gets a process enabler query from an inspector.
Parameters	`osid.workflow.rules.ProcessEnablerQueryInspector`	`processEnablerQueryInspector`	a process enabler query inspector
Return	`osid.workflow.rules.ProcessEnablerQuery`		the process enabler query
Errors	NULL_ARGUMENT		`processEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`processEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.