org.osid.offering.batch

Interface ParticipantBatchAdminSession

All Superinterfaces:

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

public interface ParticipantBatchAdminSession
extends ParticipantAdminSession

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

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

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

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

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

The delete operations delete Participants in bulk. To unmap a Participant from the current Catalogue, the ParticipantCatalogueAssignmentSession should be used. These delete operations attempt to remove the Participant itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasParticipants(AliasRequestList aliasRequests) Adds an Id to a Participant for the purpose of creating compatibility.
CreateResponseList	createParticipants(ParticipantBatchFormList participantForms) Creates a new set of Participants.
DeleteResponseList	deleteAllParticipants() Deletes all Participants in this Catalogue .
DeleteResponseList	deleteParticipants(IdList participantIds) Deletes participants for the given Ids.
DeleteResponseList	deleteParticipantsForOffering(Id offeringId) Deletes participants for the given offering.
DeleteResponseList	deleteParticipantsForResource(Id resourceId) Deletes participants for the given resource.
ParticipantBatchFormList	getParticipantFormsForCreate(ParticipantPeerList peers, Type[] participantRecordTypes) Gets the participant forms for creating a bunch of new participants.
ParticipantBatchFormList	getParticipantFormsForUpdate(IdList participantIds) Gets the participant forms for updating an existing set of participants.
UpdateResponseList	updateParticipants(ParticipantBatchFormList participantForms) Updates existing participants.

Methods inherited from interface org.osid.offering.ParticipantAdminSession

aliasParticipant, canCreateParticipants, canCreateParticipantWithRecordTypes, canDeleteParticipants, canManageParticipantAliases, canUpdateParticipants, createParticipant, deleteParticipant, getCatalogue, getCatalogueId, getParticipantFormForCreate, getParticipantFormForUpdate, updateParticipant

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

getParticipantFormsForCreate

ParticipantBatchFormList getParticipantFormsForCreate(ParticipantPeerList peers,
                                                    Type[] participantRecordTypes)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the participant forms for creating a bunch of new participants. A form is returned for each canonical canonical unit and term pair.

Parameters:

peers - the relationship peers

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

Returns:

the participant forms

Throws:

NotFoundException - an offeringId or resourceId is not found

NullArgumentException - peers or participantRecordTypes 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.

createParticipants

CreateResponseList createParticipants(ParticipantBatchFormList participantForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

participantForms - the participant forms

Returns:

the create responses

Throws:

NullArgumentException - participantForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantFormsForUpdate

ParticipantBatchFormList getParticipantFormsForUpdate(IdList participantIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

participantIds - the Ids of the Participant

Returns:

the participant form

Throws:

NotFoundException - a participantId is not found

NullArgumentException - participantIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateParticipants

UpdateResponseList updateParticipants(ParticipantBatchFormList participantForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

participantForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - participantForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllParticipants

DeleteResponseList deleteAllParticipants()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all Participants in this Catalogue .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteParticipants

DeleteResponseList deleteParticipants(IdList participantIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes participants for the given Ids.

Parameters:

participantIds - the Ids of the participants to delete

Returns:

the delete responses

Throws:

NullArgumentException - participantIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteParticipantsForOffering

DeleteResponseList deleteParticipantsForOffering(Id offeringId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes participants for the given offering.

Parameters:

offeringId - the Id of an offering

Returns:

the delete responses

Throws:

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteParticipantsForResource

DeleteResponseList deleteParticipantsForResource(Id resourceId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes participants for the given resource.

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasParticipants

AliasResponseList aliasParticipants(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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