Interface | osid.recognition.ConferralAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a 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 | canCreateConferrals | ||
Description |
Tests if this user can create conferrals. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known creating a | ||
Return | boolean | false if Conferral creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateConferralWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | conferralRecordTypes | array of conferral record types |
Return | boolean | true if Conferral creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | conferralRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getConferralFormForCreate | ||
Description |
Gets the conferral form for creating new conferrals. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | awardId | the Id for the award |
osid.id.Id | resourceId | the Id for the recipient | |
osid.type.Type[] | conferralRecordTypes | array of conferral record types | |
Return | osid.recognition.ConferralForm | the conferral form | |
Errors | NOT_FOUND | awardId or resourceId is not found | |
NULL_ARGUMENT | awardId, resourceId, or conferralRecordTypes
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 | createConferral | ||
Description |
Creates a new | ||
Parameters | osid.recognition.ConferralForm | conferralForm | the form for this Conferral |
Return | osid.recognition.Conferral | the new Conferral | |
Errors | ILLEGAL_STATE | conferralForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | conferralForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | conferralForm did not originate from
getConferralFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateConferrals | ||
Description |
Tests if this user can update conferrals. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known updating a | ||
Return | boolean | false if Conferral modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getConferralFormForUpdate | ||
Description |
Gets the conferral form for updating an existing conferral. A new conferral form should be requested for each update transaction. | ||
Parameters | osid.id.Id | conferralId | the Id of the Conferral |
Return | osid.recognition.ConferralForm | the conferral form | |
Errors | NOT_FOUND | conferralId is not found | |
NULL_ARGUMENT | conferralId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateConferral | ||
Description |
Updates an existing conferral. | ||
Parameters | osid.recognition.ConferralForm | conferralForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | conferralForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | conferralForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | conferralForm did not originate from
getConferralFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteConferrals | ||
Description |
Tests if this user can delete conferrals. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting an | ||
Return | boolean | false if Conferral deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteConferral | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | conferralId | the Id of the Conferral to remove |
Errors | NOT_FOUND | conferralId not found | |
NULL_ARGUMENT | conferralId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageConferralAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Conferral aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasConferral | ||
Description |
Adds an | ||
Parameters | osid.id.Id | conferralId | the Id of a Conferral |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | conferralId not found | ||
NULL_ARGUMENT | conferralId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |