Interface | osid.course.CourseOfferingAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateCourseOfferings | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CourseOffering creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCourseOfferingWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | courseOfferingRecordTypes | array of course offering record types |
Return | boolean | true if CourseOffering creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | courseOfferingRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseOfferingFormForCreate | ||
Description |
Gets the course form for creating new course offerings. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | courseId | the Id of the associated Course |
osid.id.Id | termId | the Id of the associated Term | |
osid.type.Type[] | courseOfferingRecordTypes | array of course offering record types | |
Return | osid.course.CourseOfferingForm | the course offering form | |
Errors | NOT_FOUND | courseId or termId not found | |
NULL_ARGUMENT | courseId, termId or courseOfferingRecordTypes
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCourseOffering | ||
Description |
Creates a new | ||
Parameters | osid.course.CourseOfferingForm | courseOfferingForm | the form for this CourseOffering |
Return | osid.course.CourseOffering | the new CourseOffering | |
Errors | ILLEGAL_STATE | courseOfferingForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | courseOfferingForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | activityForm did not originate from getCourseOfferingFormForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCourseOfferings | ||
Description |
Tests if this user can update | ||
Return | boolean | false if CourseOffering modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseOfferingFormForUpdate | ||
Description |
Gets the course offering form for updating an existing course offering. A new course offering form should be requested for each update transaction. | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering |
Return | osid.course.CourseOfferingForm | the course offering form | |
Errors | NOT_FOUND | courseOfferingId is not found | |
NULL_ARGUMENT | courseOfferingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCourseOffering | ||
Description |
Updates an existing course offering. | ||
Parameters | osid.course.CourseOfferingForm | courseOfferingForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | courseOfferingForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | courseOfferingForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | activityForm did not originate from getCourseOfferingFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCourseOfferings | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CourseOffering deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCourseOffering | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering to remove |
Errors | NOT_FOUND | courseOfferingId not found | |
NULL_ARGUMENT | courseOfferingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCourseOfferingAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CourseOffering aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCourseOffering | ||
Description |
Adds an | ||
Parameters | osid.id.Id | courseOfferingId | the Id of a CourseOffering |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | courseOfferingId not found | ||
NULL_ARGUMENT | courseOfferingId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |