OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.CourseRequisiteManager
Implementsosid.OsidManager
osid.course.requisite.CourseRequisiteProfile
Description

The course requisite manager provides access to course requisite sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RequisiteLookupSession: a session to retrieve requisites
  • RequisiteQuerySession: a session to query requisites
  • RequisiteSearchSession: a session to search for requisites
  • RequisiteAdminSession: a session to create and delete requisites
  • RequisiteNotificationSession: a session to receive notifications pertaining to requisite changes
  • RequisiteCourseCatalogSession: a session to look up requisite to course catalog mappings
  • RequisiteCourseCatalogAssignmentSession: a session to manage requisite to course catalog mappings
  • RequisiteSmartCourseCatalogSession: a session to manage dynamic course catalogs of requisites
MethodgetRequisiteLookupSession
Description

Gets the OsidSession associated with the requisite lookup service.

Returnosid.course.requisite.RequisiteLookupSessiona RequisiteLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteLookup() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteLookup() is true.
MethodgetRequisiteLookupSessionForCourseCatalog
Description

Gets the OsidSession associated with the requisite lookup service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.requisite.RequisiteLookupSessiona RequisiteLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteLookup() and supportsVisibleFederation() are true
MethodgetRequisiteQuerySession
Description

Gets the OsidSession associated with the requisite query service.

Returnosid.course.requisite.RequisiteQuerySessiona RequisiteQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteQuery() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteQuery() is true.
MethodgetRequisiteQuerySessionForCourseCatalog
Description

Gets the OsidSession associated with the requisite query service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.requisite.RequisiteQuerySessiona RequisiteQuerySession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteQuery() and supportsVisibleFederation() are true
MethodgetRequisiteSearchSession
Description

Gets the OsidSession associated with the requisite search service.

Returnosid.course.requisite.RequisiteSearchSessiona RequisiteSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteSearch() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteSearch() is true.
MethodgetRequisiteSearchSessionForCourseCatalog
Description

Gets the OsidSession associated with the requisite search service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.requisite.RequisiteSearchSessiona RequisiteSearchSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteSearch() and supportsVisibleFederation() are true
MethodgetRequisiteAdminSession
Description

Gets the OsidSession associated with the requisite administration service.

Returnosid.course.requisite.RequisiteAdminSessiona RequisiteAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteAdmin() is true.
MethodgetRequisiteAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the requisite administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.requisite.RequisiteAdminSessiona RequisiteAdminSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteAdmin() and supportsVisibleFederation() are true
MethodgetRequisiteNotificationSession
Description

Gets the OsidSession associated with the requisite notification service.

Parametersosid.course.requisite.RequisiteReceiverrequisiteReceiverthe notification callback
Returnosid.course.requisite.RequisiteNotificationSessiona RequisiteNotificationSession
ErrorsNULL_ARGUMENT requisiteReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteNotification() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteNotification() is true.
MethodgetRequisiteNotificationSessionForCourseCatalog
Description

Gets the OsidSession associated with the course notification service for the given course catalog.

Parametersosid.course.requisite.RequisiteReceiverrequisiteReceiverthe notification callback
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.requisite.RequisiteNotificationSessiona RequisiteNotificationSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT requisiteReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteNotification() and supportsVisibleFederation() are true
MethodgetRequisiteCourseCatalogSession
Description

Gets the OsidSession to lookup requisite/catalog mappings.

Returnosid.course.requisite.RequisiteCourseCatalogSessiona RequisiteCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteCourseCatalog() is true.
MethodgetRequisiteCourseCatalogAssignmentSession
Description

Gets the OsidSession associated with assigning requisites to course catalogs.

Returnosid.course.requisite.RequisiteCourseCatalogAssignmentSessiona RequisiteCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteCourseCatalogAssignment() is true.
MethodgetRequisiteSmartCourseCatalogSession
Description

Gets the OsidSession associated with the requisite smart course catalog service.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.requisite.RequisiteSmartCourseCatalogSessiona RequisiteSmartCourseCatalogSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequisiteSmartCourseCatalog() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteSmartCourseCatalog() and supportsVisibleFederation() are true