OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.ModuleSearchSession
Implementsosid.course.syllabus.ModuleQuerySession
Description

This session provides methods for searching Module objects. 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.

MethodgetModuleSearch
Description

Gets a module search.

Returnosid.course.syllabus.ModuleSearchthe module search
CompliancemandatoryThis method must be implemented.
MethodgetModuleSearchOrder
Description

Gets a module search order. The ModuleSearchOrder is supplied to a ModuleSearch to specify the ordering of results.

Returnosid.course.syllabus.ModuleSearchOrderthe module search order interface
CompliancemandatoryThis method must be implemented.
MethodgetModulesBySearch
Description

Gets the search results matching the given search.

Parametersosid.course.syllabus.ModuleQuerymoduleQuerythe module query
osid.course.syllabus.ModuleSearchmoduleSearchthe module search
Returnosid.course.syllabus.ModuleSearchResultsthe module search results
ErrorsNULL_ARGUMENT moduleQuery or moduleSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED moduleQuery or moduleSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetModuleQueryFromInspector
Description

Gets a module query from an inspector. The inspector is available from an ModuleSearchResults.

Parametersosid.course.syllabus.ModuleQueryInspectormoduleQueryInspectora module query inspector
Returnosid.course.syllabus.ModuleQuerythe module query
ErrorsNULL_ARGUMENT moduleQueryInspector is null
UNSUPPORTED moduleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.