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

Interface	osid.workflow.rules.ProcessProcessorEnablerSmartOfficeSession
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 `ProcessProcessorEnablerQuery` can be retrieved from this session and mapped to this `Office` to create a virtual collection of `ProcessProcessorEnablers` . The process processor enablers may be sequenced using the `ProcessProcessorEnablerSearchOrder` from this session. This `Office` has a default query that matches any process processor enabler and a default search order that specifies no sequencing. The queries may be examined using a `ProcessProcessorEnablerQueryInspector. Th` e query may be modified by converting the inspector back to a `ProcessProcessorEnablerQuery` .
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	getProcessProcessorEnablerQuery
Description	Gets a process processor enabler query.
Return	`osid.workflow.rules.ProcessProcessorEnablerQuery`		the process processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablerSearchOrder
Description	Gets a process processor enabler search order.
Return	`osid.workflow.rules.ProcessProcessorEnablerSearchOrder`		the process processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessProcessorEnablerQuery
Description	Applies a process processor enabler query to this office.
Parameters	`osid.workflow.rules.ProcessProcessorEnablerQuery`	`processProcessorEnablerQuery`	the process processot enabler query
Errors	NULL_ARGUMENT		`processProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProcessProcessorEnablerQuery
Description	Gets a process processor enabler query inspector for this office.
Return	`osid.workflow.rules.ProcessProcessorEnablerQueryInspector`		the process processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProcessProcessorEnablerSequencing
Description	Applies a process processor enabler search order to this office.
Parameters	`osid.workflow.rules.ProcessProcessorEnablerSearchOrder`	`processProcessorEnablerSearchOrder`	the process processor enabler search order
Errors	NULL_ARGUMENT		`processProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`processProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcessProcessorEnablerQueryFromInspector
Description	Gets a process processor enabler query from an inspector.
Parameters	`osid.workflow.rules.ProcessProcessorEnablerQueryInspector`	`processProcessorEnablerQueryInspector`	a process processor enabler query inspector
Return	`osid.workflow.rules.ProcessProcessorEnablerQuery`		the process processor enabler query
Errors	NULL_ARGUMENT		`processProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`processProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.