OSID - osid.course.syllabus.SyllabusSearchSession Service Interface Definition

Interface	osid.course.syllabus.SyllabusSearchSession
Implements	`osid.course.syllabus.SyllabusQuerySession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session provides methods for searching `Syllabi` . The search query is constructed using the `SyllabusQuery` . The syllabus record `Type` also specifies the record for the syllabus query. `getSyllabiByQuery()` is the basic search method and returns a list of `CourseCatalog` elements. A more advanced search may be performed with `getSyllabiBySearch()` . It accepts a `SyllabusSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSyllabiBySearch()` returns a `SyllabusSearchResults` that can be used to access the resulting `SyllabusList` or be used to perform a search within the result set through `SyllabusSearch` . Syllabi may have a query record indicated by their respective record types. The query record is accessed via the `SyllabusQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getSyllabusSearch
Description	Gets a syllabus search.
Return	`osid.course.syllabus.SyllabusSearch`		the syllabus search
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusSearchOrder
Description	Gets a syllabus search order. The `SyllabusSearchOrder` is supplied to a `SyllabusSearch` to specify the ordering of results.
Return	`osid.course.syllabus.SyllabusSearchOrder`		the syllabus search order interface
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabiBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.course.syllabus.SyllabusQuery`	`syllabusQuery`	the syllabus query
Parameters	`osid.course.syllabus.SyllabusSearch`	`syllabusSearch`	the syllabus search
Return	`osid.course.syllabus.SyllabusSearchResults`		the syllabus search results
Errors	NULL_ARGUMENT		`syllabusQuery` or `syllabusSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`syllabusQuery` or `syllabusSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusQueryFromInspector
Description	Gets a syllabus query from an inspector. The inspector is available from a `SyllabusSearchResults` .
Parameters	`osid.course.syllabus.SyllabusQueryInspector`	`syllabusQueryInspector`	a syllabus query inspector
Return	`osid.course.syllabus.SyllabusQuery`		the syllabus query
Errors	NULL_ARGUMENT		`syllabusQueryInspector` is `null`
Errors	UNSUPPORTED		`syllabusQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.