| Interface | osid.acknowledgement.batch.CreditBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.acknowledgement.CreditAdminSession | ||
| 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 | getCreditFormsForCreate | ||
| Description | Gets the credit forms for creating a bunch of new credits. A form is returned for each work and resource pair. | ||
| Parameters | osid.acknowledgement.batch.CreditPeerList | peers | the relationship peers | 
| osid.type.Type[] | creditRecordTypes | array of credit record types to be included in each create operation or an empty list if none | |
| Return | osid.acknowledgement.batch.CreditBatchFormList | the credit forms | |
| Errors | NOT_FOUND | a  resourceId is not found | |
| NULL_ARGUMENT |  peers or creditRecordTypes 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 | createCredits | ||
| Description | Creates a new set of  | ||
| Parameters | osid.acknowledgement.batch.CreditBatchFormList | creditForms | the credit forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  creditForms is null  | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditFormsForUpdate | ||
| Description | Gets the credit forms for updating an existing set of credits. A new credit form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | creditIds | the  Ids of the Credits  | 
| Return | osid.acknowledgement.batch.CreditBatchFormList | the credit forms | |
| Errors | NOT_FOUND | a  creditId is not found | |
| NULL_ARGUMENT |  creditIds is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateCredits | ||
| Description | Updates existing credits. This method returns an error 
                    if the entire operation fails. Otherwise, the status of an 
                    individual update operation is indicated in the  | ||
| Parameters | osid.acknowledgement.batch.CreditBatchFormList | creditForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  creditForms is null  | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllCredits | ||
| 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 | deleteCredits | ||
| Description | Deletes credits for the given  | ||
| Parameters | osid.id.IdList | creditIds | the  Ids of the credits to delete | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  creditIds is null  | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCreditsForReference | ||
| Description | Deletes credits for the given reference. | ||
| Parameters | osid.id.Id | referenceId | the  Id of a reference | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  referenceId is null  | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCreditsForResource | ||
| Description | Deletes credits for the given resource. | ||
| Parameters | osid.id.Id | resourceId | the  Id of a 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 | deleteIneffectiveCreditsByDate | ||
| Description | Deletes credits 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 | aliasCredits | ||
| 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. | |