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

Interface	osid.course.syllabus.ModuleSearchSession
Implements	`osid.course.syllabus.ModuleQuerySession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session provides methods for searching `Modules` . The search query is constructed using the `ModuleQuery` . The module record `Type` also specifies the record for the module query. `getModulesByQuery()` is the basic search method and returns a list of `CourseCatalog` elements. A more advanced search may be performed with `getModulesBySearch()` . It accepts a `ModuleSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getModulesBySearch()` returns a `ModuleSearchResults` that can be used to access the resulting `ModuleList` or be used to perform a search within the result set through `ModuleSearch` . Modules may have a query record indicated by their respective record types. The query record is accessed via the `ModuleQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getModuleSearch
Description	Gets a module search.
Return	`osid.course.syllabus.ModuleSearch`		the module search
Compliance	`mandatory`		This method must be implemented.
Method	getModuleSearchOrder
Description	Gets a module search order. The `ModuleSearchOrder` is supplied to a `ModuleSearch` to specify the ordering of results.
Return	`osid.course.syllabus.ModuleSearchOrder`		the module search order interface
Compliance	`mandatory`		This method must be implemented.
Method	getModulesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.course.syllabus.ModuleQuery`	`moduleQuery`	the module query
Parameters	`osid.course.syllabus.ModuleSearch`	`moduleSearch`	the module search
Return	`osid.course.syllabus.ModuleSearchResults`		the module search results
Errors	NULL_ARGUMENT		`moduleQuery` or `moduleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`moduleQuery` or `moduleSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getModuleQueryFromInspector
Description	Gets a module query from an inspector. The inspector is available from a `ModuleSearchResults` .
Parameters	`osid.course.syllabus.ModuleQueryInspector`	`moduleQueryInspector`	a module query inspector
Return	`osid.course.syllabus.ModuleQuery`		the module query
Errors	NULL_ARGUMENT		`moduleQueryInspector` is `null`
Errors	UNSUPPORTED		`moduleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.