Interface | osid.recognition.AcademyAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | canCreateAcademies | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Academy creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAcademyWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | academyRecordTypes | array of academy types |
Return | boolean | true if Academy creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | academyRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademyFormForCreate | ||
Description |
Gets the academy form for creating new academies. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | academyRecordTypes | array of academy types |
Return | osid.recognition.AcademyForm | the academy form | |
Errors | NULL_ARGUMENT | academyRecordTypes 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 | createAcademy | ||
Description |
Creates a new | ||
Parameters | osid.recognition.AcademyForm | academyForm | the form for this Academy |
Return | osid.recognition.Academy | the new Academy | |
Errors | ILLEGAL_STATE | academyForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | academyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | academyForm did not originate from
getAcademyFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAcademies | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Academy modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademyFormForUpdate | ||
Description |
Gets the academy form for updating an existing academy. A new academy form should be requested for each update transaction. | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.AcademyForm | the academy form | |
Errors | NOT_FOUND | academyId is not found | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAcademy | ||
Description |
Updates an existing academy. | ||
Parameters | osid.recognition.AcademyForm | academyForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | academyForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | academyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | academyForm did not originate from
getAcademyFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAcademies | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Academy deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAcademy | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | academyId | the Id of the Academy to remove |
Errors | NOT_FOUND | academyId not found | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAcademyAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Academy aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAcademy | ||
Description |
Adds an | ||
Parameters | osid.id.Id | academyId | the Id of an Academy |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | academyId not found | ||
NULL_ARGUMENT | academyId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |