OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.RealmBatchAdminSession
Implementsosid.personnel.RealmAdminSession
Description

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

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

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

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

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

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

MethodgetRealmFormsForCreate
Description

Gets the realm forms for creating a bunch of new realms.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]realmRecordTypesarray of realm record types to be included in each create operation or an empty list if none
Returnosid.personnel.batch.RealmBatchFormListthe realm forms
ErrorsNULL_ARGUMENT realmRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRealms
Description

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

Parametersosid.personnel.batch.RealmBatchFormListrealmFormsthe realm forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT realmForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRealmFormsForUpdate
Description

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

Parametersosid.id.IdListrealmIdsthe Ids of the Realm
Returnosid.personnel.batch.RealmBatchFormListthe realm form
ErrorsNOT_FOUNDa realmId is not found
NULL_ARGUMENT realmIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRealms
Description

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

Parametersosid.personnel.batch.RealmBatchFormListrealmFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT realmForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRealms
Description

Deletes all Realms.

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

Deletes realms for the given Ids.

Parametersosid.id.IdListrealmIdsthe Ids of the realms to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT realmIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasRealms
Description

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