OSID - osid.course.program.EnrollmentQuerySession Service Interface Definition

Interface	osid.course.program.EnrollmentQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.course.program.EnrollmentSearchSession`
Used By	`osid.course.program.CourseProgramManager`
Used By	`osid.course.program.CourseProgramProxyManager`
Description	This session provides methods for searching among `Enrollments`. The search query is constructed using the `EnrollmentQuery`. This session defines views that offer differing behaviors for searching. federated course catalog view: searches include enrollments in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to enrollments in this course catalog enrollments may have a query record indicated by their respective recor types. The query record is accessed via the `EnrollmentQuery`.
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	canSearchEnrollments
Description	Tests if this user can perform `Enrollment` 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 enrollments 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	getEnrollmentQuery
Description	Gets an enrollment query.
Return	`osid.course.program.EnrollmentQuery`		the enrollment query
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsByQuery
Description	Gets a list of `Enrollments` matching the given enrollment query.
Parameters	`osid.course.program.EnrollmentQuery`	`enrollmentQuery`	the enrollment query
Return	`osid.course.program.EnrollmentList`		the returned `EnrollmentList`
Errors	NULL_ARGUMENT		`enrollmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`enrollmentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.