OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.OublietteBatchAdminSession
Implementsosid.hold.OublietteAdminSession
Description

This session creates, updates, and deletes Oubliettes 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 an Oubliette, an OublietteForm is requested using getOublietteFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned OublietteForms 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 an OublietteForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OublietteForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Oubliettes in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetOublietteFormsForCreate
Description

Gets the oubliette forms for creating a bunch of new oubliettes.

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

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

Parametersosid.hold.batch.OublietteBatchFormListoublietteFormsthe oubliette forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT oublietteForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOublietteFormsForUpdate
Description

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

Parametersosid.id.IdListoublietteIdsthe Ids of the Oubliette
Returnosid.hold.batch.OublietteBatchFormListthe oubliette form
ErrorsNOT_FOUNDan oublietteId is not found
NULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOubliettes
Description

Updates existing oubliettes. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.hold.batch.OublietteBatchFormListoublietteFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT oublietteForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllOubliettes
Description

Deletes all Oubliettes.

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

Deletes oubliettes for the given Ids.

Parametersosid.id.IdListoublietteIdsthe Ids of the oubliettes to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT oublietteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOubliettes
Description

Adds an Id to an Oubliette for the purpose of creating compatibility. The primary Id of the Oubliette is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another oubliette, 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.