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

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

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 requisites in this course catalog
  • sequestered requisite viiew: All requisite methods suppress sequestered requisites.
  • unsequestered requisite view: All requisite methods return all requisites.

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

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRequisites
Description

Tests if this user can perform Requisite searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
Description

Federates the view for methods in this session. A federated view will include requisites in course catalog which are children of this course catalog in the course catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethoduseSequesteredRequisiteView
Description

The returns from the search methods omit sequestered requisites.

CompliancemandatoryThis method is must be implemented.
MethoduseUnsequesteredRequisiteView
Description

All requisites are returned including sequestered requisites.

CompliancemandatoryThis method is must be implemented.
MethodgetRequisiteQuery
Description

Gets a requisite query.

Returnosid.course.requisite.RequisiteQuerythe requisite query
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesByQuery
Description

Gets a list of Requisites matching the given requisite query.

Parametersosid.course.requisite.RequisiteQueryrequisiteQuerythe requisite query
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT requisiteQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED requisiteQuery is not of this service
CompliancemandatoryThis method must be implemented.