Interface | osid.course.TermAdminSession | ||
---|---|---|---|
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 | canCreateTerms | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Term creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateTermWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | termRecordTypes | array of term record types |
Return | boolean | true if Term creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | termRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getTermFormForCreate | ||
Description |
Gets the term form for creating new terms. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | termRecordTypes | array of term record types |
Return | osid.course.TermForm | the term form | |
Errors | NULL_ARGUMENT | termRecordTypes 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 | createTerm | ||
Description |
Creates a new | ||
Parameters | osid.course.TermForm | termForm | the form for this Term |
Return | osid.course.Term | the new Term | |
Errors | ILLEGAL_STATE | termForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | termForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | termForm did not originate from
getTermFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateTerms | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Term modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTermFormForUpdate | ||
Description |
Gets the term form for updating an existing term. A new term form should be requested for each update transaction. | ||
Parameters | osid.id.Id | termId | the Id of the Term |
Return | osid.course.TermForm | the term form | |
Errors | NOT_FOUND | termId is not found | |
NULL_ARGUMENT | termId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateTerm | ||
Description |
Updates an existing term. | ||
Parameters | osid.course.TermForm | termForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | termForm already used in anjupdate transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | termId or termForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | termForm did not originate from
getTermFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteTerms | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Term deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteTerm | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | termId | the Id of the Term to remove |
Errors | NOT_FOUND | termId not found | |
NULL_ARGUMENT | termId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageTermAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Term aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasTerm | ||
Description |
Adds an | ||
Parameters | osid.id.Id | termId | the Id of a Term |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | termId not found | ||
NULL_ARGUMENT | termId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |