public interface GradeEntryBatchAdminSession extends GradeEntryAdminSession
This session creates, updates, and deletes GradeEntries
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
GradeEntry,
a GradeEntryForm
is requested using
getGradeEntryFormsForCreate()
specifying the desired
gradebook column, resource, and record Types
or none if no
record Types
are needed. Each of the returned
GradeEntryForms
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 GradeEntryForm
is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each GradeEntryForm
corresponds to an attempted transaction.
The GradeEntryForms
returned from
getGradeEntryFormsForCreate()
may be linked to the originating
request through the peer Ids
of the GradeEntryForm.
In the case where there may be duplicates, any
GradeEntryForm
of the same peer Ids
may be used for
a create operation.
Once a batch of GradeEntryForms
are submitted for
create, a CreateResponse
is returned for each
GradeEntryForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createGradeEntries(),
errors specific to an individual
GradeEntryForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating GradeEntryForm
through the
GradeEntryForm
Id
.
For updates, GradeEntryForms
are requested to the
GradeEntry
Id
that is to be updated using
getGradeEntryFormsForUpdate()
where the reference Id
in the GradeEntryForm
may be used to link the
request. Similarly, the GradeEntryForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The GradeEntryForm
can only be used
once for a successful update and cannot be reused.
Once a batch of GradeEntryForms
are submitted for
update, an UpdateResponse
is returned for each
GradeEntryForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateGradeEntries(),
errors specific to an individual
GradeEntryForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating GradeEntryForm
through the
GradeEntryForm
Id.
The delete operations delete GradeEntries
in bulk. To
unmap a GradeEntry
from the current Gradebook,
the GradeEntryGradebookAssignmentSession
should be
used. These delete operations attempt to remove the GradeEntry
itself thus removing it from all known Gradebook
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasGradeEntries(AliasRequestList aliasRequests)
Adds an
Id to a GradeEntry for the
purpose of creating compatibility. |
CreateResponseList |
createGradeEntries(GradeEntryBatchFormList gradeEntryForms)
Creates a new set of
GradeEntries. |
DeleteResponseList |
deleteAllGradeEntries()
Deletes all
GradeEntries in this Gradebook
. |
DeleteResponseList |
deleteGradeEntries(IdList gradeEntryIds)
Deletes grade entries for the given
Ids. |
DeleteResponseList |
deleteGradeEntriesForGradebookColumn(Id gradebookColumnId)
Deletes grade entries for the given column.
|
DeleteResponseList |
deleteGradeEntriesForResource(Id resourceId)
Deletes grade entries for the given resource.
|
DeleteResponseList |
deleteIneffectiveGradeEntriesByDate(DateTime date)
Deletes grade entries expired before the given date.
|
GradeEntryBatchFormList |
getGradeEntryFormsForCreate(GradeEntryPeerList peers,
Type[] gradeEntryRecordTypes)
Gets the grade entry forms for creating a bunch of new grade entries.
|
GradeEntryBatchFormList |
getGradeEntryFormsForUpdate(IdList gradeEntryIds)
Gets the grade entry forms for updating an existing set of grade
entries.
|
UpdateResponseList |
updateGradeEntries(GradeEntryBatchFormList gradeEntryForms)
Updates existing grade entries.
|
aliasGradeEntry, canCreateGradeEntries, canCreateGradeEntryWithRecordTypes, canDeleteGradeEntries, canManageGradeEntryAliases, canOverridecalculatedGradeEntries, canUpdateGradeEntries, createGradeEntry, deleteGradeEntry, getGradebook, getGradebookId, getGradeEntryFormForCreate, getGradeEntryFormForOverride, getGradeEntryFormForUpdate, overrideCalculatedGradeEntry, updateGradeEntry
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GradeEntryBatchFormList getGradeEntryFormsForCreate(GradeEntryPeerList peers, Type[] gradeEntryRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersgradeEntryRecordTypes
- array of grade entry record types to be
included in each create operation or an empty list if noneNotFoundException
- a gradebookColumnId
or resourceId
is not foundNullArgumentException
- peers
or
gradeEntryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createGradeEntries(GradeEntryBatchFormList gradeEntryForms) throws OperationFailedException, PermissionDeniedException
GradeEntries.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.gradeEntryForms
- the grade entry formsNullArgumentException
- gradeEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryBatchFormList getGradeEntryFormsForUpdate(IdList gradeEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradeEntryIds
- the Ids
of the GradeEntry
NotFoundException
- a gradeEntryId
is
not foundNullArgumentException
- gradeEntryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateGradeEntries(GradeEntryBatchFormList gradeEntryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.gradeEntryForms
- the form containing the elements to be updatedNullArgumentException
- gradeEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllGradeEntries() throws OperationFailedException, PermissionDeniedException
GradeEntries
in this Gradebook
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGradeEntries(IdList gradeEntryIds) throws OperationFailedException, PermissionDeniedException
Ids.
gradeEntryIds
- the Ids
of the grade entries to
deleteNullArgumentException
- gradeEntryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteGradeEntriesForResource(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. DeleteResponseList deleteGradeEntriesForGradebookColumn(Id gradebookColumnId) throws OperationFailedException, PermissionDeniedException
gradebookColumnId
- the Id
of a workNullArgumentException
- gradebookColumnId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveGradeEntriesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasGradeEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a GradeEntry
for the
purpose of creating compatibility. The primary Id
of
the GradeEntry
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another grade entry, it is reassigned to the
given grade entry Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.