org.osid.resourcing.batch

Interface FoundryBatchAdminSession

All Superinterfaces:

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

public interface FoundryBatchAdminSession
extends FoundryAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasFoundries(AliasRequestList aliasRequests) Adds an Id to a Foundry for the purpose of creating compatibility.
CreateResponseList	createFoundries(FoundryBatchFormList foundryForms) Creates a new set of Foundries.
DeleteResponseList	deleteAllFoundries() Deletes all Foundries.
DeleteResponseList	deleteFoundries(IdList foundryIds) Deletes foundries for the given Ids.
FoundryBatchFormList	getFoundryFormsForCreate(long number, Type[] foundryRecordTypes) Gets the foundry forms for creating a bunch of new foundries.
FoundryBatchFormList	getFoundryFormsForUpdate(IdList foundryIds) Gets the foundry forms for updating an existing set of foundries.
UpdateResponseList	updateFoundries(FoundryBatchFormList foundryForms) Updates existing foundries.

Methods inherited from interface org.osid.resourcing.FoundryAdminSession

aliasFoundry, canCreateFoundries, canCreateFoundryWithRecordTypes, canDeleteFoundries, canManageFoundryAliases, canUpdateFoundries, createFoundry, deleteFoundry, getFoundryFormForCreate, getFoundryFormForUpdate, updateFoundry

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

getFoundryFormsForCreate

FoundryBatchFormList getFoundryFormsForCreate(long number,
                                            Type[] foundryRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the foundry forms for creating a bunch of new foundries.

Parameters:

number - the number of forms to retrieve

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

Returns:

the foundry forms

Throws:

NullArgumentException - foundryRecordTypes 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.

createFoundries

CreateResponseList createFoundries(FoundryBatchFormList foundryForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

foundryForms - the foundry forms

Returns:

the create responses

Throws:

NullArgumentException - foundryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryFormsForUpdate

FoundryBatchFormList getFoundryFormsForUpdate(IdList foundryIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

foundryIds - the Ids of the Foundry

Returns:

the foundry form

Throws:

NotFoundException - a foundryId is not found

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateFoundries

UpdateResponseList updateFoundries(FoundryBatchFormList foundryForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

foundryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - foundryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllFoundries

DeleteResponseList deleteAllFoundries()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Foundries.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteFoundries

DeleteResponseList deleteFoundries(IdList foundryIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes foundries for the given Ids.

Parameters:

foundryIds - the Ids of the foundries to delete

Returns:

the delete responses

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasFoundries

AliasResponseList aliasFoundries(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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