OSID - osid.rules.check.AgendaQuerySession Service Interface Definition

Interface	osid.rules.check.AgendaQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Agenda` objects. The search query is constructed using the `AgendaQuery.` This session defines views that offer differing behaviors for searching. federated engine view: searches include agendas in engines of which this engine is an ancestor in the engine hierarchy isolated engine view: searches are restricted to agendas in this engine Agendas may have a query record indicated by their respective record types. The query record is accessed via the `AgendaQuery.`
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAgendas
Description	Tests if this user can perform `Agenda` 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	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include agendas in engine which are children of this engine in the engine hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedEngineView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAgendaQuery
Description	Gets an agenda query.
Return	`osid.rules.check.AgendaQuery`		the agenda query
Compliance	`mandatory`		This method must be implemented.
Method	getAgendasByQuery
Description	Gets a list of `Agendas` matching the given agenda query.
Parameters	`osid.rules.check.AgendaQuery`	`agendaQuery`	the agenda query
Return	`osid.rules.check.AgendaList`		the returned `AgendaList`
Errors	NULL_ARGUMENT		`agendaQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agendaQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.