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

Interface	osid.workflow.rules.ProcessProcessorEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.workflow.rules.ProcessProcessorEnablerSearchSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods for searching among `ProcessProcessorEnabler` objects. The search query is constructed using the `ProcessProcessorEnablerQuery` . This session defines views that offer differing behaviors for searching. federated office view: searches include process processor enablers in offices of which this office is an ancestor in the office hierarchy isolated office view: searches are restricted to process processor enablers in this office Process processor enablers may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchProcessProcessorEnablers
Description	Tests if this user can perform `ProcessProcessorEnabler` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedOfficeView
Description	Federates the view for methods in this session. A federated view will include process processor enablers in offices which are children of this office in the office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this office only.
Compliance	`mandatory`		This method is 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	getProcessProcessorEnablersByQuery
Description	Gets a list of `ProcessProcessorEnablers` matching the given search.
Parameters	`osid.workflow.rules.ProcessProcessorEnablerQuery`	`processProcessorEnablerQuery`	the process processor enabler query
Return	`osid.workflow.rules.ProcessProcessorEnablerList`		the returned `ProcessProcessorEnablerList`
Errors	NULL_ARGUMENT		`processProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`processProcessorEnablerQuery` did not originate from `getProcessProcessorEnablerQuery()`
Compliance	`mandatory`		This method must be implemented.