Interface | osid.course.CourseCatalogAdminSession | ||
---|---|---|---|
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 | canCreateCourseCatalogs | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CourseCatalog creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCourseCatalogWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | courseCatalogRecordTypes | array of course catalog record types |
Return | boolean | true if CourseCatalog creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | courseCatalogRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogFormForCreate | ||
Description |
Gets the course catalog form for creating new course catalogs. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | courseCatalogRecordTypes | array of course catalog record types |
Return | osid.course.CourseCatalogForm | the course catalog form | |
Errors | NULL_ARGUMENT | courseCatalogRecordTypes 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 | createCourseCatalog | ||
Description |
Creates a new | ||
Parameters | osid.course.CourseCatalogForm | courseCatalogForm | the form for this CourseCatalog |
Return | osid.course.CourseCatalog | the new CourseCatalog | |
Errors | ILLEGAL_STATE | courseCatalogForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | courseCatalogForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | courseCatalogForm did not originate from
getCourseCatalogFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCourseCatalogs | ||
Description |
Tests if this user can update | ||
Return | boolean | false if CourseCatalog modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogFormForUpdate | ||
Description |
Gets the course catalog form for updating an existing course catalog. A new course catalog form should be requested for each update transaction. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseCatalogForm | the course catalog form | |
Errors | NOT_FOUND | courseCatalogId is not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCourseCatalog | ||
Description |
Updates an existing course catalog. | ||
Parameters | osid.course.CourseCatalogForm | courseCatalogForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | courseCatalogForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | courseCatalogForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | courseCatalogForm did not originate from
getCourseCatalogFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCourseCatalogs | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CourseCatalog deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCourseCatalog | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog to remove |
Errors | NOT_FOUND | courseCatalogId not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCourseCatalogAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CourseCatalog aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCourseCatalog | ||
Description |
Adds an | ||
Parameters | osid.id.Id | courseCatalogId | the Id of a CourseCatalog |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | aliasId is in use as a primary Id | ||
NULL_ARGUMENT | courseCatalogId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |