| Interface | osid.course.syllabus.DocetCourseCatalogAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | This session provides methods to re-assign   Adding a reference of an  | ||
| Method | canAssignDocets | ||
| Description | Tests if this user can alter docet/course catalog 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                     | ||
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignDocetsToCourseCatalog | ||
| Description | Tests if this user can alter docet/course catalog 
                    mappings. A return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known mapping methods in this session will result in a 
                     | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Errors | NULL_ARGUMENT |  courseCatalogId is null  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCourseCatalogIds | ||
| Description | Gets a list of course catalogs including and under the given course catalog node in which any docet can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.id.IdList | list of assignable course catalog  Ids  | |
| Errors | NULL_ARGUMENT |  courseCatalogId is null  | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCourseCatalogIdsForDocet | ||
| Description | Gets a list of course catalogs including and under the given course catalog node in which a specific docet can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| osid.id.Id | docetId | the  Id of the Docet  | |
| Return | osid.id.IdList | list of assignable course catalog  Ids  | |
| Errors | NULL_ARGUMENT |  courseCatalogId or docetId is null 
 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignDocetToCourseCatalog | ||
| Description | Adds an existing  | ||
| Parameters | osid.id.Id | docetId | the  Id of the Docet  | 
| osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | |
| Errors | NOT_FOUND |  docetId or courseCatalogId not found | |
| NULL_ARGUMENT |  docetId or courseCatalogId is null 
 | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignDocetFromCourseCatalog | ||
| Description | Removes an  | ||
| Parameters | osid.id.Id | docetId | the  Id of the Docet  | 
| osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | |
| Errors | NOT_FOUND |  docetId or courseCatalogId not found | |
| NULL_ARGUMENT |  docetId or courseCatalogId is null 
 | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignDocetToCourseCatalog | ||
| Description | Moves a  | ||
| Parameters | osid.id.Id | docetId | the  Id of the Docet  | 
| osid.id.Id | fromCourseCatalogId | the  Id of the current CourseCatalog  | |
| osid.id.Id | toCourseCatalogId | the  Id of the destination CourseCatalog  | |
| Errors | NOT_FOUND |  docetId, fromCourseCatalogId, or toCourseCatalogId 
not found or docetId not mapped to 
fromCourseCatalogId  | |
| NULL_ARGUMENT |  docetId, fromCourseCatalogId, or toCourseCatalogId 
is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |