public interface AwardEntryBatchAdminSession extends AwardEntryAdminSession
This session creates, updates, and deletes AwardEntries
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 an
AwardEntry,
an AwardEntryForm
is requested
using getAwardEntryFormsForCreate()
specifying the desired
award, student, and record Types
or none if no record
Types
are needed. Each of the returned
AwardEntryForms
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 an AwardEntryForm
is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each AwardEntryForm
corresponds to an attempted transaction.
The AwardEntryForms
returned from
getAwardEntryFormsForCreate()
may be linked to the originating
request through the peer Ids
of the AwardEntryForm.
In the case where there may be duplicates, any
AwardEntryForm
of the same peer Ids
may be used for
a create operation.
Once a batch of AwardEntryForms
are submitted for
create, a CreateResponse
is returned for each
AwardEntryForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createAwardEntries(),
errors specific to an individual
AwardEntryForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating AwardEntryForm
through the
AwardEntryForm
Id
.
For updates, AwardEntryForms
are requested to the
AwardEntry
Id
that is to be updated using
getAwardEntryFormsForUpdate()
where the reference Id
in the AwardEntryForm
may be used to link the
request. Similarly, the AwardEntryForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The AwardEntryForm
can only be used
once for a successful update and cannot be reused.
Once a batch of AwardEntryForms
are submitted for
update, an UpdateResponse
is returned for each
AwardEntryForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateAwardEntries(),
errors specific to an individual
AwardEntryForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating AwardEntryForm
through the
AwardEntryForm
Id.
The delete operations delete AwardEntries
in bulk. To
unmap an AwardEntry
from the current CourseCatalog,
the AwardEntryCourseCatalogAssignmentSession
should
be used. These delete operations attempt to remove the AwardEntry
itself thus removing it from all known CourseCatalog
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasAwardEntries(AliasRequestList aliasRequests)
Adds an
Id to an AwardEntry for the
purpose of creating compatibility. |
CreateResponseList |
createAwardEntries(AwardEntryBatchFormList awardEntryForms)
Creates a new set of
AwardEntries. |
DeleteResponseList |
deleteAllAwardEntries()
Deletes all
AwardEntries in this CourseCatalog
. |
DeleteResponseList |
deleteAwardEntries(IdList awardEntryIds)
Deletes award entries for the given
Ids. |
DeleteResponseList |
deleteAwardEntriesForAward(IdList awardId)
Deletes award entries for the given award.
|
DeleteResponseList |
deleteAwardEntriesForStudent(IdList resourceId)
Deletes award entries for the given student.
|
DeleteResponseList |
deleteIneffectiveAwardEntriesByDate(DateTime date)
Deletes award entries expired before the given date.
|
AwardEntryBatchFormList |
getAwardEntryFormsForCreate(AwardEntryPeerList peers,
Type[] awardEntryRecordTypes)
Gets the award entry forms for creating a bunch of new award entries.
|
AwardEntryBatchFormList |
getAwardEntryFormsForUpdate(IdList awardEntryIds)
Gets the award entry forms for updating an existing set of award
entries.
|
UpdateResponseList |
updateAwardEntries(AwardEntryBatchFormList awardEntryForms)
Updates existing award entries.
|
aliasAwardEntry, canCreateAwardEntries, canCreateAwardEntryWithRecordTypes, canDeleteAwardEntries, canManageAwardEntryAliases, canUpdateAwardEntries, createAwardEntry, deleteAwardEntry, getAwardEntryFormForCreate, getAwardEntryFormForUpdate, getCourseCatalog, getCourseCatalogId, updateAwardEntry
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AwardEntryBatchFormList getAwardEntryFormsForCreate(AwardEntryPeerList peers, Type[] awardEntryRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersawardEntryRecordTypes
- array of award entry record types to be
included in each create operation or an empty list if noneNotFoundException
- an awardId
or
studentId
is not foundNullArgumentException
- peers
or
awardEntryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAwardEntries(AwardEntryBatchFormList awardEntryForms) throws OperationFailedException, PermissionDeniedException
AwardEntries.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.awardEntryForms
- the award entry formsNullArgumentException
- awardEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryBatchFormList getAwardEntryFormsForUpdate(IdList awardEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
awardEntryIds
- the Ids
of the AwardEntry
NotFoundException
- an awardEntryId
is
not foundNullArgumentException
- awardEntryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAwardEntries(AwardEntryBatchFormList awardEntryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.awardEntryForms
- the form containing the elements to be updatedNullArgumentException
- awardEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAwardEntries() throws OperationFailedException, PermissionDeniedException
AwardEntries
in this CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAwardEntries(IdList awardEntryIds) throws OperationFailedException, PermissionDeniedException
Ids.
awardEntryIds
- the Ids
of the award entries to
deleteNullArgumentException
- awardEntryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAwardEntriesForAward(IdList awardId) throws OperationFailedException, PermissionDeniedException
awardId
- an Id
of an awardNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAwardEntriesForStudent(IdList resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- an Id
of a studentNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveAwardEntriesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAwardEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an AwardEntry
for the
purpose of creating compatibility. The primary Id
of
the AwardEntry
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another award entry, it is reassigned to the
given award entry Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.