Interface | osid.recognition.AwardAcademyAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignAwards | ||
Description |
Tests if this user can alter award/academy 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 | canAssignAwardsToAcademy | ||
Description |
Tests if this user can alter award/academy 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 | academyId | the Id of the Academy |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | academyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableAcademyIds | ||
Description |
Gets a list of academies including and under the given academy node in which any award can be assigned. | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.id.IdList | list of assignable academy Ids | |
Errors | NULL_ARGUMENT | academyId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableAcademyIdsForAward | ||
Description |
Gets a list of academies including and under the given academy node in which a specific award can be assigned. | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
osid.id.Id | awardId | the Id of the Award | |
Return | osid.id.IdList | list of assignable academy Ids | |
Errors | NULL_ARGUMENT | academyId or awardId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignAwardToAcademy | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | awardId | the Id of the Award |
osid.id.Id | academyId | the Id of the Academy | |
Errors | ALREADY_EXISTS | awardId is already assigned to academyId | |
NOT_FOUND | awardId or academyId not found | ||
NULL_ARGUMENT | awardId or academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAwardFromAcademy | ||
Description |
Removes an | ||
Parameters | osid.id.Id | awardId | the Id of the Award |
osid.id.Id | academyId | the Id of the Academy | |
Errors | NOT_FOUND | awardId or academyId not found or
awardId not asigned to academyId | |
NULL_ARGUMENT | awardId or academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |