Interface | osid.recognition.AwardAdminSession | ||
---|---|---|---|
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 | getAcademyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Academy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademy | ||
Description |
Gets the | ||
Return | osid.recognition.Academy | the academy | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAwards | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Award creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAwardWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | awardRecordTypes | array of award record types |
Return | boolean | true if Award creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | awardRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardFormForCreate | ||
Description |
Gets the award form for creating new awards. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | awardRecordTypes | array of award record types |
Return | osid.recognition.AwardForm | the award form | |
Errors | NULL_ARGUMENT | awardRecordTypes 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 | createAward | ||
Description |
Creates a new | ||
Parameters | osid.recognition.AwardForm | awardForm | the form for this Award |
Return | osid.recognition.Award | the new Award | |
Errors | ILLEGAL_STATE | awardForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | awardForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | awardForm did not originate from
getAwardFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAwards | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Award modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardFormForUpdate | ||
Description |
Gets the award form for updating an existing award. A new award form should be requested for each update transaction. | ||
Parameters | osid.id.Id | awardId | the Id of the Award |
Return | osid.recognition.AwardForm | the award form | |
Errors | NOT_FOUND | awardId is not found | |
NULL_ARGUMENT | awardId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAward | ||
Description |
Updates an existing award. | ||
Parameters | osid.recognition.AwardForm | awardForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | awardForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | awardForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | awardForm did not originate from
getAwardFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAwards | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Award deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAward | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | awardId | the Id of the Award to remove |
Errors | NOT_FOUND | awardId not found | |
NULL_ARGUMENT | awardId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAwardAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Award aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAward | ||
Description |
Adds an | ||
Parameters | osid.id.Id | awardId | the Id of an Award |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | awardId not found | ||
NULL_ARGUMENT | awardId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |