OSID - osid.control.InputQuerySession Service Interface Definition

Interface	osid.control.InputQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.control.InputSearchSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session provides methods for searching among `Inputs`. The search query is constructed using the `InputQuery`. This session defines views that offer differing behaviors for searching. federated trigger view: searches include inputs in triggers of which this trigger is an ancestor in the trigger hierarchy isolated trigger view: searches are restricted to inputs in this trigger Inputs may have a query record indicated by their respective record types. The query record is accessed via the `InputQuery`.
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	canSearchInputs
Description	Tests if this user can perform `Input` 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 inputs 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	getInputQuery
Description	Gets an input query.
Return	`osid.control.InputQuery`		the input query
Compliance	`mandatory`		This method must be implemented.
Method	getInputsByQuery
Description	Gets a list of `Inputs` matching the given input query.
Parameters	`osid.control.InputQuery`	`inputQuery`	the input query
Return	`osid.control.InputList`		the returned `InputList`
Errors	NULL_ARGUMENT		`inputQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inputQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.