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

Interface	osid.course.syllabus.DocetSearchSession
Implements	`osid.course.syllabus.DocetQuerySession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session provides methods for searching `Docets` . The search query is constructed using the `DocetQuery` . The docet record `Type` also specifies the record for the docet query. `getDocetsByQuery()` is the basic search method and returns a list of `Docet` elements. A more advanced search may be performed with `getDocetsBySearch()` . It accepts a `DocetSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDocetsBySearch()` returns a `DocetSearchResults` that can be used to access the resulting `DocetList` or be used to perform a search within the result set through `DocetSearch` . Docetsmay have a query record indicated by their respective record types. The query record is accessed via the `DocetQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getDocetSearch
Description	Gets a docet search.
Return	`osid.course.syllabus.DocetSearch`		the docet search
Compliance	`mandatory`		This method must be implemented.
Method	getDocetSearchOrder
Description	Gets a docet search order. The `DocetSearchOrder` is supplied to a `DocetSearch` to specify the ordering of results.
Return	`osid.course.syllabus.DocetSearchOrder`		the docet search order
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.course.syllabus.DocetQuery`	`docetQuery`	the docet query
Parameters	`osid.course.syllabus.DocetSearch`	`docetSearch`	the docet search
Return	`osid.course.syllabus.DocetSearchResults`		the docet search results
Errors	NULL_ARGUMENT		`docetQuery` or `docetSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`docetQuery` or `docetSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDocetQueryFromInspector
Description	Gets a docet query from an inspector. The inspector is available from a `DocetSearchResults` .
Parameters	`osid.course.syllabus.DocetQueryInspector`	`docetQueryInspector`	a docet query inspector
Return	`osid.course.syllabus.DocetQuery`		the course catalog query
Errors	NULL_ARGUMENT		`docetQueryInspector` is `null`
Errors	UNSUPPORTED		`docetQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.