Interface | osid.course.program.EnrollmentSmartCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An This | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartCourseCatalogs | ||
Description |
Tests if this user can manage smart course catalogs. A
return of true does not guarantee successful assessment. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart course catalog management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentQuery | ||
Description |
Gets an enrollment query. | ||
Return | osid.course.program.EnrollmentQuery | the enrollment query | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentSearchOrder | ||
Description |
Gets an enrollment search order. | ||
Return | osid.course.program.EnrollmentSearchOrder | the enrollment search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyEnrollmentQuery | ||
Description |
Applies an enrollment query to this course catalog. | ||
Parameters | osid.course.program.EnrollmentQuery | enrollmentQuery | the enrollment query |
Errors | NULL_ARGUMENT | enrollmentQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | enrollmentQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectEnrollmentQuery | ||
Description |
Gets an enrollment query inspector for this course catalog. | ||
Return | osid.course.program.EnrollmentQueryInspector | the enrollment query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyEnrollmentSequencing | ||
Description |
Applies an enrollment search order to this course catalog. | ||
Parameters | osid.course.program.EnrollmentSearchOrder | enrollmentSearchOrder | the enrollment search order |
Errors | NULL_ARGUMENT | enrollmentSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | enrollmentSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentQueryFromInspector | ||
Description |
Gets an enrollment query from an inspector. | ||
Parameters | osid.course.program.EnrollmentQueryInspector | enrollmentQueryInspector | a query inspector |
Return | osid.course.program.EnrollmentQuery | the enrollment query | |
Errors | NULL_ARGUMENT | enrollmentQueryInspector is null | |
UNSUPPORTED | enrollmentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |