| Interface | osid.recognition.batch.ConferralBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.recognition.ConferralAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getConferralFormsForCreate | ||
| Description | 
                     Gets the conferral forms for creating a bunch of new conferrals. A new form is retuned for each supplied award and recipient.  | ||
| Parameters | osid.recognition.batch.ConferralPeerList | peers | a list of conferral peers | 
osid.type.Type[] | conferralRecordTypes | array of conferral record types to be included in each create operation or an empty list if none | |
| Return | osid.recognition.batch.ConferralBatchFormList | the conferral forms | |
| Errors | NOT_FOUND | an  awardId  or  resourceId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  conferralRecordTypes  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createConferrals | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.recognition.batch.ConferralBatchFormList | conferralForms | the conferral forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  conferralForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getConferralFormsForUpdate | ||
| Description | 
                     Gets the conferral forms for updating an existing set of conferrals. A new conferral form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | conferralIds | the  Ids  of the  Conferral   | 
| Return | osid.recognition.batch.ConferralBatchFormList | the conferral form | |
| Errors | NOT_FOUND | a  conferralId  is not found  |                 |
| NULL_ARGUMENT |  conferralIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateConferrals | ||
| Description | 
                     Updates existing conferrals. This method returns an 
                    error if the entire operation fails. Otherwise, the status 
                    of an individual update operation is indicated in the 
                      | ||
| Parameters | osid.recognition.batch.ConferralBatchFormList | conferralForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  conferralForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllConferrals | ||
| Description | 
                     Deletes all   | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteConferrals | ||
| Description | 
                     Deletes conferrals for the given   | ||
| Parameters | osid.id.IdList | conferralIds | the  Ids  of the conferrals to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  conferralIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteConferralsForAward | ||
| Description | 
                     Deletes conferrals for the given award.  | ||
| Parameters | osid.id.Id | awardId | the  Id  of the award  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  awardId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteConferralsForRecipient | ||
| Description | 
                     Deletes conferrals for the given recipient.  | ||
| Parameters | osid.id.Id | resourceId | the  Id  of the resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveConferralsByDate | ||
| Description | 
                     Deletes conferrals expired before the given date.  | ||
| Parameters | osid.calendaring.DateTime | date | a date | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  date  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasConferrals | ||
| Description | 
                     Adds an   | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests | 
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT |  aliasRequests  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |