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

Interface	osid.course.program.EnrollmentSearchSession
Implements	`osid.course.program.EnrollmentQuerySession`
Description	This session provides methods for searching among `Enrollment` objects. The search query is constructed using the `EnrollmentQuery.` `getEnrollmentsByQuery()` is the basic search method and returns a list of `Enrollments.` A more advanced search may be performed with `getEnrollmentsBySearch().` It accepts an `EnrollmentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getEnrollmentsBySearch()` returns an `EnrollmentSearchResults` that can be used to access the resulting `EnrollmentList` or be used to perform a search within the result set through `EnrollmentSearch.` 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 record types. The query record is accessed via the `EnrollmentQuery.`
Method	getEnrollmentSearch
Description	Gets an enrollment search.
Return	`osid.course.program.EnrollmentSearch`		the enrollment search
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentSearchOrder
Description	Gets an enrollment search order. The `EnrollmentSearchOrder` is supplied to an `EnrollmentSearch` to specify the ordering of results.
Return	`osid.course.program.EnrollmentSearchOrder`		the enrollment search order
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.program.EnrollmentQuery`	`enrollmentQuery`	the enrollment query
Parameters	`osid.course.program.EnrollmentSearch`	`enrollmentSearch`	the enrollment search
Return	`osid.course.program.EnrollmentSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`enrollmentQuery` or `enrollmentSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`enrollmentQuery` or `enrollmentSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentQueryFromInspector
Description	Gets an enrollment query from an inspector. The inspector is available from an `EnrollmentSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`enrollmentQueryInspector`	an enrollment query inspector
Return	`osid.course.program.EnrollmentQuery`		the enrollment query
Errors	NULL_ARGUMENT		`enrollmentQueryInspector` is `null`
Errors	UNSUPPORTED		`enrollmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.