Interface | osid.course.program.ProgramSmartCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A 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 | getProgramQuery | ||
Description |
Gets a program query. | ||
Return | osid.course.program.ProgramQuery | the program query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramSearchOrder | ||
Description |
Gets a program search order. | ||
Return | osid.course.program.ProgramSearchOrder | the program search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyProgramQuery | ||
Description |
Applies a program query to this course catalog. | ||
Parameters | osid.course.program.ProgramQuery | programQuery | the program query |
Errors | NULL_ARGUMENT | programQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | programQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectProgramQuery | ||
Description |
Gets a program query inspector for this course catalog. | ||
Return | osid.course.program.ProgramQueryInspector | the program query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyProgramSequencing | ||
Description |
Applies a program search order to this course catalog. | ||
Parameters | osid.course.program.ProgramSearchOrder | programSearchOrder | the program search order |
Errors | NULL_ARGUMENT | programSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | programSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramQueryFromInspector | ||
Description |
Gets a program query from an inspector. | ||
Parameters | osid.course.program.ProgramQueryInspector | programQueryInspector | a query inspector |
Return | osid.course.program.ProgramQuery | the program query | |
Errors | NULL_ARGUMENT | programQueryInspector is null | |
UNSUPPORTED | programQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |