org.osid.recipe.batch

Interface ProcedureBatchAdminSession

All Superinterfaces:

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

public interface ProcedureBatchAdminSession
extends ProcedureAdminSession

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

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

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

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

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

The delete operations delete Procedures in bulk. To unmap a Procedure from the current Cookbook, the ProcedureCookbookAssignmentSession should be used. These delete operations attempt to remove the Procedure itself thus removing it from all known Cookbook catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProcedures(AliasRequestList aliasRequests) Adds an Id to a Procedure for the purpose of creating compatibility.
CreateResponseList	createProcedures(ProcedureBatchFormList procedureForms) Creates a new set of Procedures.
DeleteResponseList	deleteAllProcedures() Deletes all Procedures in this Cookbook .
DeleteResponseList	deleteProcedures(IdList procedureIds) Deletes procedures for the given Ids.
ProcedureBatchFormList	getProcedureFormsForCreate(long number, Type[] procedureRecordTypes) Gets the procedure forms for creating a bunch of new procedures.
ProcedureBatchFormList	getProcedureFormsForUpdate(IdList procedureIds) Gets the procedure forms for updating an existing set of procedures.
UpdateResponseList	updateProcedures(ProcedureBatchFormList procedureForms) Updates existing procedures.

Methods inherited from interface org.osid.recipe.ProcedureAdminSession

aliasProcedure, canCreateProcedures, canCreateProcedureWithRecordTypes, canDeleteProcedure, canDeleteProcedures, canManageProcedureAliases, canUpdateProcedure, canUpdateProcedures, createProcedure, deleteProcedure, deleteProcedures, getCookbook, getCookbookId, getProcedureFormForCreate, getProcedureFormForUpdate, updateProcedure

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

getProcedureFormsForCreate

ProcedureBatchFormList getProcedureFormsForCreate(long number,
                                                Type[] procedureRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets the procedure forms for creating a bunch of new procedures.

Parameters:

number - the number of forms to retrieve

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

Returns:

the procedure forms

Throws:

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

createProcedures

CreateResponseList createProcedures(ProcedureBatchFormList procedureForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

procedureForms - the procedure forms

Returns:

the create responses

Throws:

NullArgumentException - procedureForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcedureFormsForUpdate

ProcedureBatchFormList getProcedureFormsForUpdate(IdList procedureIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

procedureIds - the Ids of the Procedure

Returns:

the procedure form

Throws:

NotFoundException - a procedureId is not found

NullArgumentException - procedureIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProcedures

UpdateResponseList updateProcedures(ProcedureBatchFormList procedureForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

procedureForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - procedureForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProcedures

DeleteResponseList deleteAllProcedures()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Procedures in this Cookbook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProcedures

DeleteResponseList deleteProcedures(IdList procedureIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes procedures for the given Ids.

Parameters:

procedureIds - the Ids of the procedures to delete

Returns:

the delete responses

Throws:

NullArgumentException - procedureIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProcedures

AliasResponseList aliasProcedures(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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