OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.FoundryBatchAdminSession
Implementsosid.resourcing.FoundryAdminSession
Description

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.

MethodgetFoundryFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]foundryRecordTypesarray of foundry record types to be included in each create operation or an empty list if none
Returnosid.resourcing.batch.FoundryBatchFormListthe foundry forms
ErrorsNULL_ARGUMENT foundryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateFoundries
Description

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 .

Parametersosid.resourcing.batch.FoundryBatchFormListfoundryFormsthe foundry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT foundryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundryFormsForUpdate
Description

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

Parametersosid.id.IdListfoundryIdsthe Ids of the Foundry
Returnosid.resourcing.batch.FoundryBatchFormListthe foundry form
ErrorsNOT_FOUNDa foundryId is not found
NULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateFoundries
Description

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 .

Parametersosid.resourcing.batch.FoundryBatchFormListfoundryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT foundryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllFoundries
Description

Deletes all Foundries.

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

Deletes foundries for the given Ids.

Parametersosid.id.IdListfoundryIdsthe Ids of the foundries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasFoundries
Description

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.

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.