OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceBatchAdminSession
Implementsosid.resource.ResourceAdminSession
Description

This session creates, updates, and deletes Resources in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Resource, a ResourceForm is requested using getResourceFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ResourceForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a ResourceForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ResourceForm corresponds to an attempted transaction.

The ResourceForms returned from getResourceFormsForCreate() may be linked to the originating request through the peer Ids of the ResourceForm. In the case where there may be duplicates, any ResourceForm of the same peer Ids may be used for a create operation.

Once a batch of ResourceForms are submitted for create, a CreateResponse is returned for each ResourceForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createResources(), errors specific to an individual ResourceForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ResourceForm through the ResourceForm Id .

For updates, ResourceForms are requested to the Resource Id that is to be updated using getResourceFormsForUpdate() where the reference Id in the ResourceForm may be used to link the request. Similarly, the ResourceForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ResourceForm can only be used once for a successful update and cannot be reused.

Once a batch of ResourceForms are submitted for update, an UpdateResponse is returned for each ResourceForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateResources(), errors specific to an individual ResourceForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ResourceForm through the ResourceForm Id.

The delete operations delete Resources in bulk. To unmap a Resource from the current Bin, the ResourceBinAssignmentSession should be used. These delete operations attempt to remove the Resource itself thus removing it from all known Bin catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetResourceFormsForCreate
Description

Gets the resource forms for creating a bunch of new resources.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]resourceRecordTypesarray of resource record types to be included in each create operation or an empty list if none
Returnosid.resource.batch.ResourceBatchFormListthe resource forms
ErrorsNULL_ARGUMENT resourceRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateResources
Description

Creates a new set of Resources. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.resource.batch.ResourceBatchFormListresourceFormsthe resource forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT resourceForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourceFormsForUpdate
Description

Gets the resource forms for updating an existing set of resources. A new resource form should be requested for each update transaction.

Parametersosid.id.IdListresourceIdsthe Ids of the Resource
Returnosid.resource.batch.ResourceBatchFormListthe resource form
ErrorsNOT_FOUNDa resourceId is not found
NULL_ARGUMENT resourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateResources
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 BatchCreateResponse .

Parametersosid.resource.batch.ResourceBatchFormListresourceFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT resourceForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllResources
Description

Deletes all Resources in this Bin .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteResources
Description

Deletes resources for the given Ids.

Parametersosid.id.IdListresourceIdsthe Ids of the resources to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasResources
Description

Adds an Id to a Resource for the purpose of creating compatibility. The primary Id of the Resource is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another resource, it is reassigned to the given entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.