OSID Logo
OSID Specifications
recipe batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.batch.ProcedureBatchAdminSession
Implementsosid.recipe.ProcedureAdminSession
Description

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.

MethodgetProcedureFormsForCreate
Description

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

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

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 .

Parametersosid.recipe.batch.ProcedureBatchFormListprocedureFormsthe procedure forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT procedureForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcedureFormsForUpdate
Description

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

Parametersosid.id.IdListprocedureIdsthe Ids of the Procedure
Returnosid.recipe.batch.ProcedureBatchFormListthe procedure form
ErrorsNOT_FOUNDa procedureId is not found
NULL_ARGUMENT procedureIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProcedures
Description

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 .

Parametersosid.recipe.batch.ProcedureBatchFormListprocedureFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT procedureForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllProcedures
Description

Deletes all Procedures in this Cookbook .

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

Deletes procedures for the given Ids.

Parametersosid.id.IdListprocedureIdsthe Ids of the procedures to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT procedureIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasProcedures
Description

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.

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.