OSID - osid.control.SceneQuerySession Service Interface Definition

Interface	osid.control.SceneQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Scene` objects. The search query is constructed using the `SceneQuery.` This session defines views that offer differing behaviors for searching. federated system view: searches include scenes in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to scenes in this system scenes may have a query record indicated by their respective record types. The query record is accessed via the `SceneQuery.`
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	canSearchScenes
Description	Tests if this user can perform `Scene` 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 scenes in systems which are children of this system 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	getSceneQuery
Description	Gets a scene query.
Return	`osid.control.SceneQuery`		the scene query
Compliance	`mandatory`		This method must be implemented.
Method	getScenesByQuery
Description	Gets a list of `Scenes` matching the given scene query.
Parameters	`osid.control.SceneQuery`	`sceneQuery`	the scene query
Return	`osid.control.SceneList`		the returned `SceneList`
Errors	NULL_ARGUMENT		`sceneQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sceneQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.