OSID Logo
OSID Specifications
id batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.id.batch.IdBatchAdminSession
Implementsosid.id.IdAdminSession
Description

This session creates Ids in bulk. The data for create is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create operations differ in their usage. To create an Id, an IdForm is requested using getIdFormsForCreate() specifying the desired reference, resource, and record Types or none if no record Types are needed. Each of the returned IdForms 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 IdForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each IdForm corresponds to an attempted transaction.

The IdForms returned from getIdFormsForCreate() may be linked to the originating request through the peer Ids of the IdForm.

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

MethodgetIdFormsForCreate
Description

Gets the Id forms for creating new Ids. A new form should be requested for each create transaction.

Parameterscardinalnumberther number of forms to request
Returnosid.id.batch.IdBatchFormListthe Id forms
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcreateIds
Description

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

Parametersosid.id.batch.IdBatchFormListidFormsthe Id forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT idForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasIds
Description

Makes a set of Ids known to this service equivalent such that for each primary and equivalent Id in the given array, calls to IdLookupSession.getId(equivalentId) return the primaryId.

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.