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

Interface	osid.workflow.rules.ProcessProcessorSmartOfficeSession
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 catalogs. A `ProcessProcessorQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `ProcessProcessors` . The process processors may be sequenced using the `ProcessProcessorSearchOrder` from this session. This `Office` has a default query that matches any process processor and a default search order that specifies no sequencing. The queries may be examined using a `ProcessProcessorQueryInspector` . The query may be modified by converting the inspector back to a `ProcessProcessorQuery` .
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	getProcessProcessorQuery
Description	Gets a process processor query.
Return	`osid.workflow.rules.ProcessProcessorQuery`		the process processor query
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorSearchOrder
Description	Gets a process processor search order.
Return	`osid.workflow.rules.ProcessProcessorSearchOrder`		the process processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessProcessorQuery
Description	Applies a process processor query to this office.
Parameters	`osid.workflow.rules.ProcessProcessorQuery`	`processProcessorQuery`	the process processor query
Errors	NULL_ARGUMENT		`processProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProcessProcessorQuery
Description	Gets a process processor query inspector for this office.
Return	`osid.workflow.rules.ProcessProcessorQueryInspector`		the process processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessProcessorSequencing
Description	Applies a process processor search order to this office.
Parameters	`osid.workflow.rules.ProcessProcessorSearchOrder`	`processProcessorSearchOrder`	the process processor search order
Errors	NULL_ARGUMENT		`processProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorQueryFromInspector
Description	Gets a process processor query from an inspector.
Parameters	`osid.workflow.rules.ProcessProcessorQueryInspector`	`processProcessorQueryInspector`	a process processor query inspector
Return	`osid.workflow.rules.ProcessProcessorQuery`		the process processor query
Errors	NULL_ARGUMENT		`processProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`processProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.