org.osid.hold.batch

Interface OublietteBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, OublietteAdminSession

public interface OublietteBatchAdminSession
extends OublietteAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasOubliettes(AliasRequestList aliasRequests) Adds an Id to an Oubliette for the purpose of creating compatibility.
CreateResponseList	createOubliettes(OublietteBatchFormList oublietteForms) Creates a new set of Oubliettes.
DeleteResponseList	deleteAllOubliettes() Deletes all Oubliettes.
DeleteResponseList	deleteOubliettes(IdList oublietteIds) Deletes oubliettes for the given Ids.
OublietteBatchFormList	getOublietteFormsForCreate(long number, Type[] oublietteRecordTypes) Gets the oubliette forms for creating a bunch of new oubliettes.
OublietteBatchFormList	getOublietteFormsForUpdate(IdList oublietteIds) Gets the oubliette forms for updating an existing set of oubliettes.
UpdateResponseList	updateOubliettes(OublietteBatchFormList oublietteForms) Updates existing oubliettes.

Methods inherited from interface org.osid.hold.OublietteAdminSession

aliasOubliette, canCreateOubliette, canCreateOublietteWithRecordTypes, canDeleteOubliettes, canManageOublietteAliases, canUpdateOubliettes, createOubliette, deleteOubliette, getOublietteFormForCreate, getOublietteFormForUpdate, updateOubliette

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getOublietteFormsForCreate

OublietteBatchFormList getOublietteFormsForCreate(long number,
                                                Type[] oublietteRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

oublietteRecordTypes - array of oubliette record types to be included in each create operation or an empty list if none

Returns:

the oubliette forms

Throws:

NullArgumentException - oublietteRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createOubliettes

CreateResponseList createOubliettes(OublietteBatchFormList oublietteForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

oublietteForms - the oubliette forms

Returns:

the create responses

Throws:

NullArgumentException - oublietteForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteFormsForUpdate

OublietteBatchFormList getOublietteFormsForUpdate(IdList oublietteIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

oublietteIds - the Ids of the Oubliette

Returns:

the oubliette form

Throws:

NotFoundException - an oublietteId is not found

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateOubliettes

UpdateResponseList updateOubliettes(OublietteBatchFormList oublietteForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

oublietteForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - oublietteForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllOubliettes

DeleteResponseList deleteAllOubliettes()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Oubliettes.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteOubliettes

DeleteResponseList deleteOubliettes(IdList oublietteIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes oubliettes for the given Ids.

Parameters:

oublietteIds - the Ids of the oubliettes to delete

Returns:

the delete responses

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasOubliettes

AliasResponseList aliasOubliettes(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.