Interface | osid.course.chronicle.AwardEntryCourseCatalogAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignAwardEntries | ||
Description |
Tests if this user can alter award entry/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 | canAssignAwardEntryToCourseCatalog | ||
Description |
Tests if this user can alter award entry/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 award entry 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 | getAssignableCourseCatalogIdsForAwardEntry | ||
Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific award entry can be assigned. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | awardEntryId | the Id of the AwardEntry | |
Return | osid.id.IdList | list of assignable course catalog Ids | |
Errors | NULL_ARGUMENT | courseCatalogId or awardEntryId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignAwardEntryToCourseCatalog | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | awardEntryId | the Id of the AwardEntry |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | ALREADY_EXISTS | awardEntryId is already assigned to courseCatalogId
| |
NOT_FOUND | awardEntryId or courseCatalogId not found | ||
NULL_ARGUMENT | awardEntryId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAwardEntryFromCourseCatalog | ||
Description |
Removes an | ||
Parameters | osid.id.Id | awardEntryId | the Id of the AwardEntry |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | NOT_FOUND | awardEntryId or courseCatalogId not found or
awardEntryId not assigned to courseCatalogId | |
NULL_ARGUMENT | awardEntryId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignAwardEntryToCourseCatalog | ||
Description |
Moves an | ||
Parameters | osid.id.Id | awardEntryId | the Id of the AwardEntry |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
Errors | NOT_FOUND | awardEntryId, fromCourseCatalogId, or
toCourseCatalogId not found or awardEntryId not mapped
to fromCourseCatalogId | |
NULL_ARGUMENT | awardEntryId, fromCourseCatalogId, or
toCourseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |