Interface | osid.recognition.ConvocationAcademyAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignConvocations | ||
Description |
Tests if this user can alter convocation/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 | canAssignConvocationsToAcademy | ||
Description |
Tests if this user can alter convocation/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 convocation 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 | getAssignableAcademyIdsForConvocation | ||
Description |
Gets a list of academies including and under the given academy node in which a specific convocation can be assigned. | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
osid.id.Id | convocationId | the Id of the Convocation | |
Return | osid.id.IdList | list of assignable academy Ids | |
Errors | NULL_ARGUMENT | academyId or convocationId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignConvocationToAcademy | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | convocationId | the Id of the Convocation |
osid.id.Id | academyId | the Id of the Academy | |
Errors | ALREADY_EXISTS | convocationId is already assigned to academyId
| |
NOT_FOUND | convocationId or academyId not found | ||
NULL_ARGUMENT | convocationId or academyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignConvocationFromAcademy | ||
Description |
Removes a | ||
Parameters | osid.id.Id | convocationId | the Id of the Convocation |
osid.id.Id | academyId | the Id of the Academy | |
Errors | NOT_FOUND | convocationId or academyId not found or
convocationId not assigned to academyId | |
NULL_ARGUMENT | convocationId or academyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |