public interface ConferralBatchAdminSession extends ConferralAdminSession
This session creates, updates, and deletes Conferrals
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
Conferral,
a ConferralForm
is requested using
getConferralFormsForCreate()
specifying the desired award,
recipient, and record Types
or none if no record
Types
are needed. Each of the returned ConferralForms
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
ConferralForm
is submiited to a create operation, it cannot
be reused with another create operation unless the first operation was
unsuccessful. Each ConferralForm
corresponds to an
attempted transaction.
The ConferralForms
returned from
getConferralFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ConferralForm.
In the case where there may be duplicates, any
ConferralForm
of the same peer Ids
may be used for
a create operation.
Once a batch of ConferralForms
are submitted for
create, a CreateResponse
is returned for each
ConferralForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createConferrals(),
errors specific to an individual
ConferralForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating ConferralForm
through the
ConferralForm
Id
.
For updates, ConferralForms
are requested to the
Conferral
Id
that is to be updated using
getConferralFormsForUpdate()
where the reference Id
in the ConferralForm
may be used to link the request.
Similarly, the ConferralForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The ConferralForm
can only be used once for a
successful update and cannot be reused.
Once a batch of ConferralForms
are submitted for
update, an UpdateResponse
is returned for each
ConferralForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateConferrals(),
errors specific to an individual
ConferralForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating ConferralForm
through the
ConferralForm
Id.
The delete operations delete Conferrals
in bulk. To
unmap a Conferral
from the current Academy,
the ConferralAcademyAssignmentSession
should be used. These
delete operations attempt to remove the Conferral
itself
thus removing it from all known Academy
catalogs. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasConferrals(AliasRequestList aliasRequests)
Adds an
Id to a Conferral for the
purpose of creating compatibility. |
CreateResponseList |
createConferrals(ConferralBatchFormList conferralForms)
Creates a new set of
Conferrals. |
DeleteResponseList |
deleteAllConferrals()
Deletes all
Conferrals in this Academy . |
DeleteResponseList |
deleteConferrals(IdList conferralIds)
Deletes conferrals for the given
Ids. |
DeleteResponseList |
deleteConferralsForAward(Id awardId)
Deletes conferrals for the given award.
|
DeleteResponseList |
deleteConferralsForRecipient(Id resourceId)
Deletes conferrals for the given recipient.
|
DeleteResponseList |
deleteIneffectiveConferralsByDate(DateTime date)
Deletes conferrals expired before the given date.
|
ConferralBatchFormList |
getConferralFormsForCreate(ConferralPeerList peers,
Type[] conferralRecordTypes)
Gets the conferral forms for creating a bunch of new conferrals.
|
ConferralBatchFormList |
getConferralFormsForUpdate(IdList conferralIds)
Gets the conferral forms for updating an existing set of conferrals.
|
UpdateResponseList |
updateConferrals(ConferralBatchFormList conferralForms)
Updates existing conferrals.
|
aliasConferral, canCreateConferrals, canCreateConferralWithRecordTypes, canDeleteConferrals, canManageConferralAliases, canUpdateConferrals, createConferral, deleteConferral, getAcademy, getAcademyId, getConferralFormForCreate, getConferralFormForUpdate, updateConferral
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ConferralBatchFormList getConferralFormsForCreate(ConferralPeerList peers, Type[] conferralRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of conferral peersconferralRecordTypes
- array of conferral record types to be
included in each create operation or an empty list if noneNotFoundException
- an awardId
or
resourceId
is not foundNullArgumentException
- peers
or
conferralRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createConferrals(ConferralBatchFormList conferralForms) throws OperationFailedException, PermissionDeniedException
Conferrals.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.conferralForms
- the conferral formsNullArgumentException
- conferralForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralBatchFormList getConferralFormsForUpdate(IdList conferralIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
conferralIds
- the Ids
of the Conferral
NotFoundException
- a conferralId
is not
foundNullArgumentException
- conferralIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateConferrals(ConferralBatchFormList conferralForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.conferralForms
- the form containing the elements to be updatedNullArgumentException
- conferralForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllConferrals() throws OperationFailedException, PermissionDeniedException
Conferrals
in this Academy
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteConferrals(IdList conferralIds) throws OperationFailedException, PermissionDeniedException
Ids.
conferralIds
- the Ids
of the conferrals to
deleteNullArgumentException
- conferralIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
awardId
- the Id
of the awardNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of the resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveConferralsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasConferrals(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Conferral
for the
purpose of creating compatibility. The primary Id
of
the Conferral
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another conferral, it is reassigned to the given
conferral Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.