OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CourseProgramManager
Implementsosid.OsidManager
osid.course.program.CourseProgramProfile
Description

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

  • ProgramLookupSession: a session to retrieve programs
  • ProgramQuerySession: a session to query programs
  • ProgramSearchSession: a session to search for programs
  • ProgramAdminSession: a session to create and delete programs
  • ProgramNotificationSession: a session to receive notifications pertaining to program changes
  • ProgramCourseCatalogSession: a session to look up program to course catalog mappings
  • ProgramCourseCatalogAssignmentSession: a session to manage program to course catalog mappings
  • ProgramSmartCourseCatalogSession: a session to manage dynamic course catalogs of programs
  • CourseProgramLookupSession: a session to look up course to program mappings
  • CourseProgramAssignmentSession: a session to manage course to program mappings
  • ProgramOfferingLookupSession: a session to retrieve program offerings
  • ProgramOfferingQuerySession: a session to query program offerings
  • ProgramOfferingSearchSession: a session to search for program offerings
  • ProgramOfferingAdminSession: a session to create and delete program offerings
  • ProgramOfferingNotificationSession: a session to receive notifications pertaining to program offering changes
  • ProgramOfferingCourseCatalogSession: a session to look up program offering to course catalog mappings
  • ProgramOfferingCourseCatalogAssignmentSession: a session to manage program offering to course catalog mappings
  • ProgramOfferingSmartCourseCatalogSession: a session to manage dynamic course catalogs of program offerings
  • CredentialLookupSession: a session to retrieve credentials
  • CredentialQuerySession: a session to query credentials
  • CredentialSearchSession: a session to search for credentials
  • CredentialAdminSession: a session to create and delete credentials
  • CredentialNotificationSession: a session to receive notifications pertaining to credential changes
  • CredentialCourseCatalogSession: a session to look up credential to course catalog mappings
  • CredentialCourseCatalogAssignmentSession: a session to manage credential to course catalog mappings
  • CredentialSmartCourseCatalogSession: a session to manage dynamic course catalogs of credentials
  • EnrollmentLookupSession: a session to retrieve enrollments
  • EnrollmentQuerySession: a session to query enrollments
  • EnrollmentSearchSession: a session to search for enrollments
  • EnrollmentAdminSession: a session to create and delete enrollments
  • EnrollmentNotificationSession: a session to receive notifications pertaining to enrollment changes
  • EnrollmentCourseCatalogSession: a session to look up enrollment to course catalog mappings
  • EnrollmentCourseCatalogAssignmentSession: a session to manage enrollment to course catalog mappings
  • EnrollmentSmartCourseCatalogSession: a session to manage dynamic course catalogs of enrollments
MethodgetProgramLookupSession
Description

Gets the OsidSession associated with the program lookup service.

Returnosid.course.program.ProgramLookupSessiona ProgramLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramLookup() is false
ComplianceoptionalThis method must be implemented if supportsProgramLookup() is true.
MethodgetProgramLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.program.ProgramLookupSessiona ProgramLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramLookup() and supportsVisibleFederation() are true
MethodgetProgramQuerySession
Description

Gets the OsidSession associated with the program query service.

Returnosid.course.program.ProgramQuerySessiona ProgramQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramQuery() is true.
MethodgetProgramQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramQuerySessiona ProgramQuerySession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramQuery() and supportsVisibleFederation() are true
MethodgetProgramSearchSession
Description

Gets the OsidSession associated with the program search service.

Returnosid.course.program.ProgramSearchSessiona ProgramSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramSearch() is false
ComplianceoptionalThis method must be implemented if supportsProgramSearch() is true.
MethodgetProgramSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramSearchSessiona ProgramSearchSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramSearch() and supportsVisibleFederation() are true
MethodgetProgramAdminSession
Description

Gets the OsidSession associated with the program administration service.

Returnosid.course.program.ProgramAdminSessiona ProgramAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProgramAdmin() is true.
MethodgetProgramAdminSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramAdminSessiona ProgramAdminSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramAdmin() and supportsVisibleFederation() are true
MethodgetProgramNotificationSession
Description

Gets the OsidSession associated with the program notification service.

Parametersosid.course.program.ProgramReceiverprogramReceiverthe notification callback
Returnosid.course.program.ProgramNotificationSessiona ProgramNotificationSession
ErrorsNULL_ARGUMENT programReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramNotification() is false
ComplianceoptionalThis method must be implemented if supportsProgramNotification() is true.
MethodgetProgramNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.program.ProgramReceiverprogramReceiverthe notification callback
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramNotificationSessiona ProgramNotificationSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT programReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramNotification() and supportsVisibleFederation() are true
MethodgetProgramCourseCatalogSession
Description

Gets the OsidSession to lookup program/catalog mappings.

Returnosid.course.program.ProgramCourseCatalogSessiona ProgramCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsProgramCourseCatalog() is true.
MethodgetProgramCourseCatalogAssignmentSession
Description

Gets the OsidSession associated with assigning programs to course catalogs.

Returnosid.course.program.ProgramCourseCatalogAssignmentSessiona ProgramCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProgramCourseCatalogAssignment() is true.
MethodgetProgramSmartCourseCatalogSession
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramSmartCourseCatalogSessiona ProgramSmartCourseCatalogSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramSmartCourseCatalog() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramSmartCourseCatalog() and supportsVisibleFederation() are true
MethodgetCourseProgramLookupSession
Description

Gets the OsidSession associated with looking up course to program mappings.

Returnosid.course.program.CourseProgramLookupSessiona CourseProgramLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCourseProgramLookup() is false
ComplianceoptionalThis method must be implemented if supportsCourseProgramLookup() is true.
MethodgetCourseProgramLookupSessionForCourseCatalog
Description

Gets the OsidSession associated with looking up course to program mappings for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.program.CourseProgramLookupSessiona CourseProgramLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCourseProgramLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCourseProgramLookup() and supportsVisibleFederation() are true
MethodgetCourseProgramAssignmentSession
Description

Gets the OsidSession associated with managing course to program mappings.

Returnosid.course.program.CourseProgramAssignmentSessiona CourseProgramAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCourseProgramAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCourseProgramAssignment() is true.
MethodgetCourseProgramAssignmentSessionForCourseCatalog
Description

Gets the OsidSession associated with managing course to program mappings for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.program.CourseProgramAssignmentSessiona CourseProgramAssignmentSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCourseProgramAssignment() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCourseProgramAssignment() and supportsVisibleFederation() are true
MethodgetProgramOfferingLookupSession
Description

Gets the OsidSession associated with the program offering lookup service.

Returnosid.course.program.ProgramOfferingLookupSessiona ProgramOfferingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingLookup() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingLookup() is true.
MethodgetProgramOfferingLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.program.ProgramOfferingLookupSessiona ProgramOfferingLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingLookup() and supportsVisibleFederation() are true
MethodgetProgramOfferingQuerySession
Description

Gets the OsidSession associated with the program offering query service.

Returnosid.course.program.ProgramQuerySessiona ProgramOfferingQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingQuery() is true.
MethodgetProgramOfferingQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramQuerySessiona ProgramOfferingQuerySession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingQuery() and supportsVisibleFederation() are true
MethodgetProgramOfferingSearchSession
Description

Gets the OsidSession associated with the program offering search service.

Returnosid.course.program.ProgramOfferingSearchSessiona ProgramOfferingSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingSearch() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingSearch() is true.
MethodgetProgramOfferingSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramOfferingSearchSessiona ProgramOfferingSearchSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingSearch() and supportsVisibleFederation() are true
MethodgetProgramOfferingAdminSession
Description

Gets the OsidSession associated with the program offering administration service.

Returnosid.course.program.ProgramOfferingAdminSessiona ProgramOfferingAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingAdmin() is true.
MethodgetProgramOfferingAdminSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramOfferingAdminSessiona ProgramOfferingAdminSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingAdmin() and supportsVisibleFederation() are true
MethodgetProgramOfferingNotificationSession
Description

Gets the OsidSession associated with the program offering notification service.

Parametersosid.course.program.ProgramOfferingReceiverprogramOfferingReceiverthe notification callback
Returnosid.course.program.ProgramOfferingNotificationSessiona ProgramOfferingNotificationSession
ErrorsNULL_ARGUMENT programOfferingReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingNotification() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingNotification() is true.
MethodgetProgramOfferingNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.program.ProgramOfferingReceiverprogramOfferingReceiverthe notification callback
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramOfferingNotificationSessiona ProgramOfferingNotificationSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT programOfferingReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingNotification() and supportsVisibleFederation() are true
MethodgetProgramOfferingCourseCatalogSession
Description

Gets the OsidSession to lookup program offering/catalog mappings.

Returnosid.course.program.ProgramOfferingCourseCatalogSessiona ProgramOfferingCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingCourseCatalog() is true.
MethodgetProgramOfferingCourseCatalogAssignmentSession
Description

Gets the OsidSession associated with assigning program offerings to course catalogs.

Returnosid.course.program.ProgramOfferingCourseCatalogAssignmentSessiona ProgramOfferingCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingCourseCatalogAssignment() is true.
MethodgetProgramOfferingSmartCourseCatalogSession
Description

Gets the OsidSession associated with the program offering smart course catalog service.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.ProgramOfferingSmartCourseCatalogSessiona ProgramOfferingSmartCourseCatalogSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingSmartCourseCatalog() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingSmartCourseCatalog() and supportsVisibleFederation() are true
MethodgetCredentialLookupSession
Description

Gets the OsidSession associated with the credential lookup service.

Returnosid.course.program.CredentialLookupSessiona CredentialLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialLookup() is false
ComplianceoptionalThis method must be implemented if supportsCredentialLookup() is true.
MethodgetCredentialLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.program.CredentialLookupSessiona CredentialLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialLookup() and supportsVisibleFederation() are true
MethodgetCredentialQuerySession
Description

Gets the OsidSession associated with the credential query service.

Returnosid.course.program.CredentialQuerySessiona CredentialQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialQuery() is false
ComplianceoptionalThis method must be implemented if supportsCredentialQuery() is true.
MethodgetCredentialQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.CredentialQuerySessiona CredentialQuerySession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialQuery() and supportsVisibleFederation() are true
MethodgetCredentialSearchSession
Description

Gets the OsidSession associated with the credential search service.

Returnosid.course.program.CredentialSearchSessiona CredentialSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialSearch() is false
ComplianceoptionalThis method must be implemented if supportsCredentialSearch() is true.
MethodgetCredentialSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.CredentialSearchSessiona CredentialSearchSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialSearch() and supportsVisibleFederation() are true
MethodgetCredentialAdminSession
Description

Gets the OsidSession associated with the credential administration service.

Returnosid.course.program.CredentialAdminSessiona CourseAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCredentialAdmin() is true.
MethodgetCredentialAdminSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.CredentialAdminSessiona CredentialAdminSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialAdmin() and supportsVisibleFederation() are true
MethodgetCredentialNotificationSession
Description

Gets the OsidSession associated with the course notification service.

Parametersosid.course.program.CredentialReceivercredentialReceiverthe notification callback
Returnosid.course.program.CredentialNotificationSessiona CredentialNotificationSession
ErrorsNULL_ARGUMENT credentialReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialNotification() is false
ComplianceoptionalThis method must be implemented if supportsCredentialNotification() is true.
MethodgetCredentialNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.program.CredentialReceivercredentialReceiverthe notification callback
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.CredentialNotificationSessiona CredentialNotificationSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT credentialReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialNotification() and supportsVisibleFederation() are true
MethodgetCredentialCourseCatalogSession
Description

Gets the OsidSession to lookup credential/catalog mappings.

Returnosid.course.program.CredentialCourseCatalogSessiona CredentialCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsCredentialCourseCatalog() is true.
MethodgetCredentialCourseCatalogAssignmentSession
Description

Gets the OsidSession associated with assigning credentials to course catalogs.

Returnosid.course.program.CredentialCourseCatalogAssignmentSessiona CredentialCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCredentialCourseCatalogAssignment() is true.
MethodgetCredentialSmartCourseCatalogSession
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.CredentialSmartCourseCatalogSessiona CredentialSmartCourseCatalogSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialSmartCourseCatalog() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialSmartCourseCatalog() and supportsVisibleFederation() are true
MethodgetEnrollmentLookupSession
Description

Gets the OsidSession associated with the enrollment lookup service.

Returnosid.course.program.EnrollmentLookupSessionan EnrollmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentLookup() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentLookup() is true.
MethodgetEnrollmentLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.program.EnrollmentLookupSessionan EnrollmentLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentLookup() and supportsVisibleFederation() are true
MethodgetEnrollmentQuerySession
Description

Gets the OsidSession associated with the enrollment query service.

Returnosid.course.program.EnrollmentQuerySessionan EnrollmentQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentQuery() is true.
MethodgetEnrollmentQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.EnrollmentQuerySessionan EnrollmentQuerySession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentQuery() and supportsVisibleFederation() are true
MethodgetEnrollmentSearchSession
Description

Gets the OsidSession associated with the enrollment search service.

Returnosid.course.program.EnrollmentSearchSessionan EnrollmentSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentSearch() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentSearch() is true.
MethodgetEnrollmentSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.EnrollmentSearchSessionan EnrollmentSearchSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentSearch() and supportsVisibleFederation() are true
MethodgetEnrollmentAdminSession
Description

Gets the OsidSession associated with the enrollment administration service.

Returnosid.course.program.EnrollmentAdminSessionan EnrollmentAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentAdmin() is true.
MethodgetEnrollmentAdminSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.EnrollmentAdminSessionan EnrollmentAdminSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentAdmin() and supportsVisibleFederation() are true
MethodgetEnrollmentNotificationSession
Description

Gets the OsidSession associated with the enrollment notification service.

Parametersosid.course.program.EnrollmentReceiverenrollmentReceiverthe notification callback
Returnosid.course.program.EnrollmentNotificationSessionan EnrollmentNotificationSession
ErrorsNULL_ARGUMENT enrollmentReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentNotification() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentNotification() is true.
MethodgetEnrollmentNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.program.EnrollmentReceiverenrollmentReceiverthe notification callback
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.EnrollmentNotificationSessionan EnrollmentNotificationSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT enrollmentReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentNotification() and supportsVisibleFederation() are true
MethodgetEnrollmentCourseCatalogSession
Description

Gets the OsidSession to lookup enrollment/catalog mappings.

Returnosid.course.program.EnrollmentCourseCatalogSessionan EnrollmentCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentCourseCatalog() is true.
MethodgetEnrollmentCourseCatalogAssignmentSession
Description

Gets the OsidSession associated with assigning enrollments to course catalogs.

Returnosid.course.program.EnrollmentCourseCatalogAssignmentSessionan EnrollmentCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentCourseCatalogAssignment() is true.
MethodgetEnrollmentSmartCourseCatalogSession
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.program.EnrollmentSmartCourseCatalogSessionan EnrollmentSmartCourseCatalogSession
ErrorsNOT_FOUNDno course catalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentSmartCourseCatalog() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentSmartCourseCatalog() and supportsVisibleFederation() are true
MethodgetCourseProgramBatchManager
Description

Gets a CourseProgramBatchManager.

Returnosid.course.program.batch.CourseProgramBatchManagera CourseProgramBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCourseProgramBatch() is false
ComplianceoptionalThis method must be implemented if supportsCourseProgramBatch() is true.