Interface | osid.course.program.CourseProgramManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getProgramLookupSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramLookupSession | a ProgramLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProgramLookup()
is true. | |
Method | getProgramLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.program.ProgramLookupSession | a ProgramLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramLookup()
and supportsVisibleFederation() are true | |
Method | getProgramQuerySession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramQuerySession | a ProgramQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProgramQuery() is
true. | |
Method | getProgramQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramQuerySession | a ProgramQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsProgramQuery()
and supportsVisibleFederation() are true | |
Method | getProgramSearchSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramSearchSession | a ProgramSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProgramSearch()
is true. | |
Method | getProgramSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramSearchSession | a ProgramSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramSearch()
and supportsVisibleFederation() are true | |
Method | getProgramAdminSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramAdminSession | a ProgramAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProgramAdmin() is
true. | |
Method | getProgramAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramAdminSession | a ProgramAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsProgramAdmin()
and supportsVisibleFederation() are true | |
Method | getProgramNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.program.ProgramReceiver | programReceiver | the notification callback |
Return | osid.course.program.ProgramNotificationSession | a ProgramNotificationSession | |
Errors | NULL_ARGUMENT | programReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramNotification() is false | ||
Compliance | optional | This method must be implemented if supportsProgramNotification()
is true. | |
Method | getProgramNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.program.ProgramReceiver | programReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.program.ProgramNotificationSession | a ProgramNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | programReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramNotification()
and supportsVisibleFederation() are true | |
Method | getProgramCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramCourseCatalogSession | a ProgramCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsProgramCourseCatalog()
is true. | |
Method | getProgramCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramCourseCatalogAssignmentSession | a ProgramCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProgramCourseCatalogAssignment() is true. | |
Method | getProgramSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramSmartCourseCatalogSession | a ProgramSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProgramSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getCourseProgramLookupSession | ||
Description |
Gets the | ||
Return | osid.course.program.CourseProgramLookupSession | a CourseProgramLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseProgramLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCourseProgramLookup()
is true. | |
Method | getCourseProgramLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.program.CourseProgramLookupSession | a CourseProgramLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseProgramLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseProgramLookup()
and supportsVisibleFederation() are true | |
Method | getCourseProgramAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.program.CourseProgramAssignmentSession | a CourseProgramAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseProgramAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsCourseProgramAssignment()
is true. | |
Method | getCourseProgramAssignmentSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.program.CourseProgramAssignmentSession | a CourseProgramAssignmentSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseProgramAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseProgramAssignment()
and supportsVisibleFederation() are true | |
Method | getProgramOfferingLookupSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramOfferingLookupSession | a ProgramOfferingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramOfferingLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingLookup()
is true. | |
Method | getProgramOfferingLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.program.ProgramOfferingLookupSession | a ProgramOfferingLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingLookup()
and supportsVisibleFederation() are true | |
Method | getProgramOfferingQuerySession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramQuerySession | a ProgramOfferingQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramOfferingQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingQuery()
is true. | |
Method | getProgramOfferingQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramQuerySession | a ProgramOfferingQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingQuery()
and supportsVisibleFederation() are true | |
Method | getProgramOfferingSearchSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramOfferingSearchSession | a ProgramOfferingSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramOfferingSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingSearch()
is true. | |
Method | getProgramOfferingSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramOfferingSearchSession | a ProgramOfferingSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingSearch()
and supportsVisibleFederation() are true | |
Method | getProgramOfferingAdminSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramOfferingAdminSession | a ProgramOfferingAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramOfferingAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingAdmin()
is true. | |
Method | getProgramOfferingAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramOfferingAdminSession | a ProgramOfferingAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProgramOfferingAdmin()
and supportsVisibleFederation() are true | |
Method | getProgramOfferingNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.program.ProgramOfferingReceiver | programOfferingReceiver | the notification callback |
Return | osid.course.program.ProgramOfferingNotificationSession | a ProgramOfferingNotificationSession | |
Errors | NULL_ARGUMENT | programOfferingReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsProgramOfferingNotification() is true. | |
Method | getProgramOfferingNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.program.ProgramOfferingReceiver | programOfferingReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.program.ProgramOfferingNotificationSession | a ProgramOfferingNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | programOfferingReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProgramOfferingNotification() and
supportsVisibleFederation() are true | |
Method | getProgramOfferingCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramOfferingCourseCatalogSession | a ProgramOfferingCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramOfferingCourseCatalog() is false
| ||
Compliance | optional | This method must be implemented if
supportsProgramOfferingCourseCatalog() is true. | |
Method | getProgramOfferingCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.program.ProgramOfferingCourseCatalogAssignmentSession | a ProgramOfferingCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProgramOfferingCourseCatalogAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsProgramOfferingCourseCatalogAssignment() is true.
| |
Method | getProgramOfferingSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.ProgramOfferingSmartCourseCatalogSession | a ProgramOfferingSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProgramOfferingSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProgramOfferingSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getCredentialLookupSession | ||
Description |
Gets the | ||
Return | osid.course.program.CredentialLookupSession | a CredentialLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCredentialLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialLookup()
is true. | |
Method | getCredentialLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.program.CredentialLookupSession | a CredentialLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialLookup()
and supportsVisibleFederation() are true | |
Method | getCredentialQuerySession | ||
Description |
Gets the | ||
Return | osid.course.program.CredentialQuerySession | a CredentialQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCredentialQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialQuery()
is true. | |
Method | getCredentialQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.CredentialQuerySession | a CredentialQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialQuery()
and supportsVisibleFederation() are true | |
Method | getCredentialSearchSession | ||
Description |
Gets the | ||
Return | osid.course.program.CredentialSearchSession | a CredentialSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCredentialSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialSearch()
is true. | |
Method | getCredentialSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.CredentialSearchSession | a CredentialSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialSearch()
and supportsVisibleFederation() are true | |
Method | getCredentialAdminSession | ||
Description |
Gets the | ||
Return | osid.course.program.CredentialAdminSession | a CourseAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCredentialAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialAdmin()
is true. | |
Method | getCredentialAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.CredentialAdminSession | a CredentialAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialAdmin()
and supportsVisibleFederation() are true | |
Method | getCredentialNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.program.CredentialReceiver | credentialReceiver | the notification callback |
Return | osid.course.program.CredentialNotificationSession | a CredentialNotificationSession | |
Errors | NULL_ARGUMENT | credentialReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialNotification()
is true. | |
Method | getCredentialNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.program.CredentialReceiver | credentialReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.program.CredentialNotificationSession | a CredentialNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | credentialReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialNotification()
and supportsVisibleFederation() are true | |
Method | getCredentialCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.program.CredentialCourseCatalogSession | a CredentialCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCredentialCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsCredentialCourseCatalog()
is true. | |
Method | getCredentialCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.program.CredentialCourseCatalogAssignmentSession | a CredentialCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCredentialCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCredentialCourseCatalogAssignment() is true. | |
Method | getCredentialSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.CredentialSmartCourseCatalogSession | a CredentialSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCredentialSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCredentialSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getEnrollmentLookupSession | ||
Description |
Gets the | ||
Return | osid.course.program.EnrollmentLookupSession | an EnrollmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEnrollmentLookup() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentLookup()
is true. | |
Method | getEnrollmentLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.program.EnrollmentLookupSession | an EnrollmentLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentLookup()
and supportsVisibleFederation() are true | |
Method | getEnrollmentQuerySession | ||
Description |
Gets the | ||
Return | osid.course.program.EnrollmentQuerySession | an EnrollmentQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEnrollmentQuery() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentQuery()
is true. | |
Method | getEnrollmentQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.EnrollmentQuerySession | an EnrollmentQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentQuery()
and supportsVisibleFederation() are true | |
Method | getEnrollmentSearchSession | ||
Description |
Gets the | ||
Return | osid.course.program.EnrollmentSearchSession | an EnrollmentSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEnrollmentSearch() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentSearch()
is true. | |
Method | getEnrollmentSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.EnrollmentSearchSession | an EnrollmentSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentSearch()
and supportsVisibleFederation() are true | |
Method | getEnrollmentAdminSession | ||
Description |
Gets the | ||
Return | osid.course.program.EnrollmentAdminSession | an EnrollmentAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEnrollmentAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentAdmin()
is true. | |
Method | getEnrollmentAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.EnrollmentAdminSession | an EnrollmentAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentAdmin()
and supportsVisibleFederation() are true | |
Method | getEnrollmentNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.program.EnrollmentReceiver | enrollmentReceiver | the notification callback |
Return | osid.course.program.EnrollmentNotificationSession | an EnrollmentNotificationSession | |
Errors | NULL_ARGUMENT | enrollmentReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentNotification() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentNotification()
is true. | |
Method | getEnrollmentNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.program.EnrollmentReceiver | enrollmentReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.program.EnrollmentNotificationSession | an EnrollmentNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | enrollmentReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentNotification()
and supportsVisibleFederation() are true | |
Method | getEnrollmentCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.program.EnrollmentCourseCatalogSession | an EnrollmentCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEnrollmentCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsEnrollmentCourseCatalog()
is true. | |
Method | getEnrollmentCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.program.EnrollmentCourseCatalogAssignmentSession | an EnrollmentCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEnrollmentCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsEnrollmentCourseCatalogAssignment() is true. | |
Method | getEnrollmentSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.program.EnrollmentSmartCourseCatalogSession | an EnrollmentSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEnrollmentSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsEnrollmentSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getCourseProgramBatchManager | ||
Description |
Gets a | ||
Return | osid.course.program.batch.CourseProgramBatchManager | a CourseProgramBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseProgramBatch() is false | ||
Compliance | optional | This method must be implemented if supportsCourseProgramBatch()
is true. |