OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.RequisiteSearchSession
Implementsosid.course.requisite.RequisiteQuerySession
Description

This session provides methods for searching among Requisites. The search query is constructed using the RequisiteQuery.

getRequisitesByQuery() is the basic search method and returns a list of Requisites. A more advanced search may be performed with getRequisitesBySearch(). It accepts a RequisiteSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRequisitesBySearch() returns a RequisiteSearchResults that can be used to access the resulting RequisiteList or be used to perform a search within the result set through RequisiteSearch.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include requisites 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

Requisites may have a query record indicated by their respective record types. The query record is accessed via the RequisiteQuery.

MethodgetRequisiteSearch
Description

Gets a requisite search.

Returnosid.course.requisite.RequisiteSearchthe requisite search
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteSearchOrder
Description

Gets a requisite search order. The RequisiteSearchOrder is supplied to a RequisiteSearch to specify the ordering of results.

Returnosid.course.requisite.RequisiteSearchOrderthe requisite search order
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.requisite.RequisiteQueryrequisiteQuerythe requisite query
osid.course.requisite.RequisiteSearchrequisiteSearchthe requisite search
Returnosid.course.requisite.RequisiteSearchResultsthe requisite search results
ErrorsNULL_ARGUMENT requisiteQuery or requisiteSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED requisiteQuery or requisiteSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteQueryFromInspector
Description

Gets a requisite query from an inspector. The inspector is available from a RequisiteSearchResults.

Parametersosid.course.requisite.RequisiteQueryInspectorrequisiteQueryInspectora requisite query inspector
Returnosid.course.requisite.RequisiteQuerythe requisite query
ErrorsNULL_ARGUMENT requisiteQueryInspector is null
UNSUPPORTED requisiteQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.