public interface AssessmentEntryBatchAdminSession extends AssessmentEntryAdminSession
This session creates, updates, and deletes AssessmentEntries
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
AssessmentEntry,
an AssessmentEntryForm
is
requested using getAssessmentEntryFormsForCreate()
specifying the desired assessment, student, and record Types
or none if no record Types
are needed. Each of the
returned AssessmentEntryForms
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 AssessmentEntryForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
AssessmentEntryForm
corresponds to an attempted
transaction.
The AssessmentEntryForms
returned from
getAssessmentEntryFormsForCreate()
may be linked to the
originating request through the peer Ids
of the
AssessmentEntryForm.
In the case where there may be duplicates,
any AssessmentEntryForm
of the same peer Ids
may be used for a create operation.
Once a batch of AssessmentEntryForms
are submitted for
create, a CreateResponse
is returned for each
AssessmentEntryForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createAssessmentEntries(),
errors specific to an individual
AssessmentEntryForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be
linked to the originating AssessmentEntryForm
through the
AssessmentEntryForm
Id
.
For updates, AssessmentEntryForms
are requested to the
AssessmentEntry
Id
that is to be updated
using getAssessmentEntryFormsForUpdate()
where the
reference Id
in the AssessmentEntryForm
may
be used to link the request. Similarly, the AssessmentEntryForm
has metadata about the data that can be updated and it can perform
validation before submitting the update. The AssessmentEntryForm
can only be used once for a successful update and cannot be
reused.
Once a batch of AssessmentEntryForms
are submitted for
update, an UpdateResponse
is returned for each
AssessmentEntryForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateAssessmentEntries(),
errors specific to an individual
AssessmentEntryForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be
linked to the originating AssessmentEntryForm
through the
AssessmentEntryForm
Id.
The delete operations delete AssessmentEntries
in bulk.
To unmap an AssessmentEntry
from the current
CourseCatalog,
the
AssessmentEntryCourseCatalogAssignmentSession
should be used.
These delete operations attempt to remove the AssessmentEntry
itself thus removing it from all known CourseCatalog
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasAssessmentEntries(AliasRequestList aliasRequests)
Adds an
Id to an AssessmentEntry for the
purpose of creating compatibility. |
CreateResponseList |
createAssessmentEntries(AssessmentEntryBatchFormList assessmentEntryForms)
Creates a new set of
AssessmentEntries. |
DeleteResponseList |
deleteAllAssessmentEntries()
Deletes all
AssessmentEntries in this
CourseCatalog . |
DeleteResponseList |
deleteAssessmentEntries(IdList assessmentEntryIds)
Deletes assessment entries for the given
Ids. |
DeleteResponseList |
deleteAssessmentEntriesForAssessment(Id assessmentId)
Deletes all assessment entries for the given assessment.
|
DeleteResponseList |
deleteAssessmentEntriesForStudent(Id resourceId)
Deletes all assessment entries for the given student.
|
DeleteResponseList |
deleteIneffectiveAssessmentEntriesByDate(DateTime date)
Deletes assessment entries expired before the given date.
|
AssessmentEntryBatchFormList |
getAssessmentEntryFormsForCreate(AssessmentEntryPeerList peers,
Type[] assessmentEntryRecordTypes)
Gets the assessment entry forms for creating a bunch of new
cressmentedential entries.
|
AssessmentEntryBatchFormList |
getAssessmentEntryFormsForUpdate(IdList assessmentEntryIds)
Gets the assessment entry forms for updating an existing set of
assessment entries.
|
UpdateResponseList |
updateAssessmentEntries(AssessmentEntryBatchFormList assessmentEntryForms)
Updates existing assessment entries.
|
aliasAssessmentEntry, canCreateAssessmentEntries, canCreateAssessmentEntryWithRecordTypes, canDeleteAssessmentEntries, canDeleteAssessmentEntry, canManageAssessmentEntryAliases, canUpdateAssessmentEntries, createAssessmentEntry, deleteAssessmentEntry, getAssessmentEntryFormForCreate, getAssessmentEntryFormForUpdate, getCourseCatalog, getCourseCatalogId, updateAssessmentEntry
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AssessmentEntryBatchFormList getAssessmentEntryFormsForCreate(AssessmentEntryPeerList peers, Type[] assessmentEntryRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntryForm
is
returned for each assessment and student pair.peers
- the relationship peersassessmentEntryRecordTypes
- array of assessment entry record
types to be included in each create operation or an empty list
if noneNotFoundException
- an assessmentId
or
stuidentId
is not foundNullArgumentException
- peers
or
assessmentEntryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAssessmentEntries(AssessmentEntryBatchFormList assessmentEntryForms) throws OperationFailedException, PermissionDeniedException
AssessmentEntries.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.assessmentEntryForms
- the assessment entry formsNullArgumentException
- assessmentEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryBatchFormList getAssessmentEntryFormsForUpdate(IdList assessmentEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
assessmentEntryIds
- the Ids
of the
AssessmentEntry
NotFoundException
- anassessment EntryId
is not foundNullArgumentException
- assessmentEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAssessmentEntries(AssessmentEntryBatchFormList assessmentEntryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.assessmentEntryForms
- the form containing the elements to be
updatedNullArgumentException
- assessmentEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAssessmentEntries() throws OperationFailedException, PermissionDeniedException
AssessmentEntries
in this
CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAssessmentEntries(IdList assessmentEntryIds) throws OperationFailedException, PermissionDeniedException
Ids.
assessmentEntryIds
- the Ids
of the assessment
entries to deleteNullArgumentException
- assessmentEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAssessmentEntriesForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
assessmentId
- an Id
of an assessmentNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAssessmentEntriesForStudent(Id 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 deleteIneffectiveAssessmentEntriesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAssessmentEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an AssessmentEntry
for the
purpose of creating compatibility. The primary Id
of
the AssessmentEntry
is determined by the provider. The
new Id
is an alias to the primary Id.
If
the alias is a pointer to another sessment entry, it is reassigned to
the given assessment entry Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.