Interface | osid.billing.payment.batch.PayerBatchAdminSession | ||
---|---|---|---|
Implements | osid.billing.payment.PayerAdminSession | ||
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 | getPayerFormsForCreate | ||
Description |
Gets the payer forms for creating a bunch of new payers. A form is returned for each supplied resource. | ||
Parameters | osid.id.IdList | resourceIds | a list of resources |
osid.type.Type[] | payerRecordTypes | array of payer record types to be included in each create operation or an empty list if none | |
Return | osid.billing.payment.batch.PayerBatchFormList | the payer forms | |
Errors | NOT_FOUND | a resource is not found | |
NULL_ARGUMENT | resourceIds or payerRecordTypes 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 | createPayers | ||
Description |
Creates a new set of | ||
Parameters | osid.billing.payment.batch.PayerBatchFormList | payerForms | the payer forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | payerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPayerFormsForUpdate | ||
Description |
Gets the payer forms for updating an existing set of payers. A new payer form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | payerIds | the Ids of the Payer |
Return | osid.billing.payment.batch.PayerBatchFormList | the payer form | |
Errors | NOT_FOUND | a payerId is not found | |
NULL_ARGUMENT | payerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePayers | ||
Description |
Updates existing payers. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.billing.payment.batch.PayerBatchFormList | payerForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | payerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPayers | ||
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 | deletePayers | ||
Description |
Deletes payers for the given | ||
Parameters | osid.id.IdList | payerIds | the Ids of the payers to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | payerIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deletePayersForResource | ||
Description |
Deletes payers 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 | deleteIneffectivePayersByDate | ||
Description |
Deletes payers ineffective 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 | aliasPayers | ||
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. |