OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.ParticipantBatchAdminSession
Implementsosid.offering.ParticipantAdminSession
Description

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.

MethodgetParticipantFormsForCreate
Description

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

Parametersosid.offering.batch.ParticipantPeerListpeersthe relationship peers
osid.type.Type[]participantRecordTypesarray of participant record types to be included in each create operation or an empty list if none
Returnosid.offering.batch.ParticipantBatchFormListthe participant forms
ErrorsNOT_FOUNDan offeringId or resourceId is not found
NULL_ARGUMENT peers or participantRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateParticipants
Description

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 .

Parametersosid.offering.batch.ParticipantBatchFormListparticipantFormsthe participant forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT participantForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParticipantFormsForUpdate
Description

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

Parametersosid.id.IdListparticipantIdsthe Ids of the Participant
Returnosid.offering.batch.ParticipantBatchFormListthe participant form
ErrorsNOT_FOUNDa participantId is not found
NULL_ARGUMENT participantIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateParticipants
Description

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 .

Parametersosid.offering.batch.ParticipantBatchFormListparticipantFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT participantForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllParticipants
Description

Deletes all Participants in this Catalogue .

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

Deletes participants for the given Ids.

Parametersosid.id.IdListparticipantIdsthe Ids of the participants to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT participantIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteParticipantsForOffering
Description

Deletes participants for the given offering.

Parametersosid.id.IdofferingIdthe Id of an offering
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteParticipantsForResource
Description

Deletes participants for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasParticipants
Description

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.

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.