OSID - osid.course.chronicle.CourseEntrySearchSession Service Interface Definition

Interface	osid.course.chronicle.CourseEntrySearchSession
Implements	`osid.course.chronicle.CourseEntryQuerySession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session provides methods for searching among `CourseEntries` . The search query is constructed using the `CourseEntryQuery` . `getCourseEntriesByQuery()` is the basic search method and returns a list of `CourseEntries` . A more advanced search may be performed with `getCourseEntriesBySearch()` .It accepts a `CourseEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCourseEntriesBySearch()` returns a `CourseEntrySearchResults` that can be used to access the resulting `CourseEntryList` or be used to perform a search within the result set through `CourseEntrySearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include course entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to courses in this course catalog CourseEntries may have a query record indicated by their respective record types. The query record is accessed via the `CourseEntryQuery` .
Method	getCourseEntrySearch
Description	Gets a course entry search.
Return	`osid.course.chronicle.CourseEntrySearch`		the course entry search
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntrySearchOrder
Description	Gets a course entry search order. The `CourseEntrySearchOrder` is supplied to a `CourseEntrySearch` to specify the ordering of results.
Return	`osid.course.chronicle.CourseEntrySearchOrder`		the course entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.chronicle.CourseEntryQuery`	`courseEntryQuery`	the course entry query
Parameters	`osid.course.chronicle.CourseEntrySearch`	`courseEntrySearch`	the course entry search
Return	`osid.course.chronicle.CourseEntrySearchResults`		the course entry search results
Errors	NULL_ARGUMENT		`courseEntryQuery` or `courseEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseEntryQuery` or `CourseEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntryQueryFromInspector
Description	Gets a course entry query from an inspector. The inspector is available from a `CourseEntrySearchResults` .
Parameters	`osid.course.chronicle.CourseEntryQueryInspector`	`courseEntryQueryInspector`	a course entry query inspector
Return	`osid.course.chronicle.CourseEntryQuery`		the course entry query
Errors	NULL_ARGUMENT		`courseEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`courseEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.