OSID - osid.control.ControllerQuerySession Service Interface Definition

Interface	osid.control.ControllerQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Controller` objects. The search query is constructed using the `ControllerQuery.` This session defines views that offer differing behaviors for searching. federated trigger view: searches include controllers in triggers of which this trigger is an ancestor in the trigger hierarchy isolated trigger view: searches are restricted to controllers in this trigger Controllers may have a query record indicated by their respective record types. The query record is accessed via the `ControllerQuery.`
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchControllers
Description	Tests if this user can perform `Controller` lookups. 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	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include controllers in systems which are children of this trigger in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	getControllerQuery
Description	Gets a controller query.
Return	`osid.control.ControllerQuery`		the controller query
Compliance	`mandatory`		This method must be implemented.
Method	getControllersByQuery
Description	Gets a list of `Controllers` matching the given controller query.
Parameters	`osid.control.ControllerQuery`	`controllerQuery`	the controller query
Return	`osid.control.ControllerList`		the returned `ControllerList`
Errors	NULL_ARGUMENT		`controllerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`controllerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.