OSID - osid.course.registration.RegistrationQuerySession Service Interface Definition

Interface	osid.course.registration.RegistrationQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.course.registration.RegistrationSearchSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session provides methods for searching among `Registration` objects. The search query is constructed using the `RegistrationQuery`. This session defines views that offer differing behaviors for searching. federated course catalog view: searches include registrations in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to registrations in this course catalog Registrations may have a query record indicated by their respective record types. The query record is accessed via the `RegistrationQuery`.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchRegistrations
Description	Tests if this user can perform `Registration` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include registrations in course catalog which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRegistrationQuery
Description	Gets a registration query.
Return	`osid.course.registration.RegistrationQuery`		the registration query
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationsByQuery
Description	Gets a list of `Registrations` matching the given registration query.
Parameters	`osid.course.registration.RegistrationQuery`	`courseQuery`	the registration query
Return	`osid.course.registration.RegistrationList`		the returned `RegistrationList`
Errors	NULL_ARGUMENT		`registrationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.