org.osid.personnel.batch

Interface PersonBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PersonAdminSession

public interface PersonBatchAdminSession
extends PersonAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPersons(AliasRequestList aliasRequests) Adds an Id to a Person for the purpose of creating compatibility.
CreateResponseList	createPersons(PersonBatchFormList personForms) Creates a new set of Persons.
DeleteResponseList	deleteAllPersons() Deletes all Persons in this Realm .
DeleteResponseList	deletePersons(IdList personIds) Deletes persons for the given Ids.
PersonBatchFormList	getPersonFormsForCreate(long number, Type[] personRecordTypes) Gets the person forms for creating a bunch of new persons.
PersonBatchFormList	getPersonFormsForUpdate(IdList personIds) Gets the person forms for updating an existing set of persons.
UpdateResponseList	updatePersons(PersonBatchFormList personForms) Updates existing persons.

Methods inherited from interface org.osid.personnel.PersonAdminSession

aliasPerson, canCreatePersons, canCreatePersonWithRecordTypes, canDeletePersons, canManagePersonAliases, canUpdatePersons, createPerson, deletePerson, getPersonFormForCreate, getPersonFormForUpdate, getRealm, getRealmId, updatePerson

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPersonFormsForCreate

PersonBatchFormList getPersonFormsForCreate(long number,
                                          Type[] personRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

personRecordTypes - array of person record types to be included in each create operation or an empty list if none

Returns:

the person forms

Throws:

NullArgumentException - personRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPersons

CreateResponseList createPersons(PersonBatchFormList personForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

personForms - the person forms

Returns:

the create responses

Throws:

NullArgumentException - personForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPersonFormsForUpdate

PersonBatchFormList getPersonFormsForUpdate(IdList personIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

personIds - the Ids of the Person

Returns:

the person form

Throws:

NotFoundException - a personId is not found

NullArgumentException - personIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePersons

UpdateResponseList updatePersons(PersonBatchFormList personForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

personForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - personForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPersons

DeleteResponseList deleteAllPersons()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Persons in this Realm .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePersons

DeleteResponseList deletePersons(IdList personIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes persons for the given Ids.

Parameters:

personIds - the Ids of the persons to delete

Returns:

the delete responses

Throws:

NullArgumentException - personIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPersons

AliasResponseList aliasPersons(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.