Interface | osid.billing.batch.CategoryBatchAdminSession | ||
---|---|---|---|
Implements | osid.billing.CategoryAdminSession | ||
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 | getCategoryFormsForCreate | ||
Description |
Gets the categoryforms for creating a bunch of new categories. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | categoryRecordTypes | array of category record types to be included in each create operation or an empty list if none | |
Return | osid.billing.batch.CategoryBatchFormList | the category forms | |
Errors | NULL_ARGUMENT | categoryRecordTypes 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 | createCategories | ||
Description |
Creates a new set of | ||
Parameters | osid.billing.batch.CategoryBatchFormList | categoryForms | the category forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | categoryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCategoryFormsForUpdate | ||
Description |
Gets the category forms for updating an existing set of categories. A new categoryform should be requested for each update transaction. | ||
Parameters | osid.id.IdList | categoryIds | the Ids of the Category |
Return | osid.billing.batch.CategoryBatchFormList | the category form | |
Errors | NOT_FOUND | a categoryId is not found | |
NULL_ARGUMENT | categoryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCategories | ||
Description |
Updates existing categories. 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.batch.CategoryBatchFormList | categoryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | categoryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCategories | ||
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 | deleteCategories | ||
Description |
Deletes categories for the given | ||
Parameters | osid.id.IdList | categoryIds | the Ids of the categories to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | categoryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCategories | ||
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. |