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.
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.
|
aliasParticipant, canCreateParticipants, canCreateParticipantWithRecordTypes, canDeleteParticipants, canManageParticipantAliases, canUpdateParticipants, createParticipant, deleteParticipant, getCatalogue, getCatalogueId, getParticipantFormForCreate, getParticipantFormForUpdate, updateParticipant
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ParticipantBatchFormList getParticipantFormsForCreate(ParticipantPeerList peers, Type[] participantRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersparticipantRecordTypes
- array of participant record types to be
included in each create operation or an empty list if noneNotFoundException
- an offeringId
or
resourceId
is not foundNullArgumentException
- peers
or
participantRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createParticipants(ParticipantBatchFormList participantForms) throws OperationFailedException, PermissionDeniedException
Participants.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.participantForms
- the participant formsNullArgumentException
- participantForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParticipantBatchFormList getParticipantFormsForUpdate(IdList participantIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
participantIds
- the Ids
of the
Participant
NotFoundException
- a participantId
is
not foundNullArgumentException
- participantIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateParticipants(ParticipantBatchFormList participantForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.participantForms
- the form containing the elements to be
updatedNullArgumentException
- participantForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllParticipants() throws OperationFailedException, PermissionDeniedException
Participants
in this Catalogue
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteParticipants(IdList participantIds) throws OperationFailedException, PermissionDeniedException
Ids.
participantIds
- the Ids
of the participants to
deleteNullArgumentException
- participantIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteParticipantsForOffering(Id offeringId) throws OperationFailedException, PermissionDeniedException
offeringId
- the Id
of an offeringNullArgumentException
- offeringId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteParticipantsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasParticipants(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.