Interface | osid.resourcing.batch.CommissionBatchAdminSession | ||
---|---|---|---|
Implements | osid.resourcing.CommissionAdminSession | ||
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 | getCommissionFormsForCreate | ||
Description |
Gets the commission forms for creating a bunch of new commissions. A form is returned for each work and resource pair. | ||
Parameters | osid.resourcing.batch.CommissionPeerList | peers | the relationship peers |
osid.type.Type[] | commissionRecordTypes | array of commission record types to be included in each create operation or an empty list if none | |
Return | osid.resourcing.batch.CommissionBatchFormList | the commission forms | |
Errors | NOT_FOUND | a workId or resourceId is not found | |
NULL_ARGUMENT | peers or commissionRecordTypes 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 | createCommissions | ||
Description |
Creates a new set of | ||
Parameters | osid.resourcing.batch.CommissionBatchFormList | commissionForms | the commission forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | commissionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionFormsForUpdate | ||
Description |
Gets the commission forms for updating an existing set of commissions. A new commission form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | commissionIds | the Ids of the Commission |
Return | osid.resourcing.batch.CommissionBatchFormList | the commission form | |
Errors | NOT_FOUND | a commissionId is not found | |
NULL_ARGUMENT | commissionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCommissions | ||
Description |
Updates existing commissions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.resourcing.batch.CommissionBatchFormList | commissionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | commissionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCommissions | ||
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 | deleteCommissions | ||
Description |
Deletes commissions for the given | ||
Parameters | osid.id.IdList | commissionIds | the Ids of the commissions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | commissionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCommissionsForResource | ||
Description |
Deletes commissions 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 | deleteCommissionsForWork | ||
Description |
Deletes commissions for the given work. | ||
Parameters | osid.id.Id | workId | the Id of a work |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | workId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveCommissionsByDate | ||
Description |
Deletes commissions 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 | aliasCommissions | ||
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. |