Interface | osid.resource.batch.ResourceBatchAdminSession | ||
---|---|---|---|
Implements | osid.resource.ResourceAdminSession | ||
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 | getResourceFormsForCreate | ||
Description |
Gets the resource forms for creating a bunch of new resources. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | resourceRecordTypes | array of resource record types to be included in each create operation or an empty list if none | |
Return | osid.resource.batch.ResourceBatchFormList | the resource forms | |
Errors | NULL_ARGUMENT | resourceRecordTypes 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 | createResources | ||
Description |
Creates a new set of | ||
Parameters | osid.resource.batch.ResourceBatchFormList | resourceForms | the resource forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | resourceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResourceFormsForUpdate | ||
Description |
Gets the resource forms for updating an existing set of resources. A new resource form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | resourceIds | the Ids of the Resource |
Return | osid.resource.batch.ResourceBatchFormList | the resource form | |
Errors | NOT_FOUND | a resourceId is not found | |
NULL_ARGUMENT | resourceIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateResources | ||
Description |
Updates existing resources. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.resource.batch.ResourceBatchFormList | resourceForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | resourceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllResources | ||
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 | deleteResources | ||
Description |
Deletes resources for the given | ||
Parameters | osid.id.IdList | resourceIds | the Ids of the resources to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasResources | ||
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. |