OSID Logo
OSID Specifications
personnel batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.batch.PersonBatchAdminSession
Implementsosid.personnel.PersonAdminSession
Description

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

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

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

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

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

The delete operations delete Persons in bulk. To unmap a Person from the current Realm, the PersonRealmAssignmentSession should be used. These delete operations attempt to remove the Person itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetPersonFormsForCreate
Description

Gets the person forms for creating a bunch of new persons.

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

Creates a new set of Persons. 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.PersonBatchFormListpersonFormsthe person forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT personForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonFormsForUpdate
Description

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

Parametersosid.id.IdListpersonIdsthe Ids of the Person
Returnosid.personnel.batch.PersonBatchFormListthe person form
ErrorsNOT_FOUNDa personId is not found
NULL_ARGUMENT personIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePersons
Description

Updates existing persons. 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.PersonBatchFormListpersonFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT personForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPersons
Description

Deletes all Persons in this Realm .

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

Deletes persons for the given Ids.

Parametersosid.id.IdListpersonIdsthe Ids of the persons to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT personIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPersons
Description

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