OSID Logo
OSID Specifications
course chronicle batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.batch.AssessmentEntryBatchAdminSession
Implementsosid.course.chronicle.AssessmentEntryAdminSession
Description

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.

MethodgetAssessmentEntryFormsForCreate
Description

Gets the assessment entry forms for creating a bunch of new cressmentedential entries. An AssessmentEntryForm is returned for each assessment and student pair.

Parametersosid.course.chronicle.batch.AssessmentEntryPeerListpeersthe relationship peers
osid.type.Type[]assessmentEntryRecordTypesarray of assessment entry record types to be included in each create operation or an empty list if none
Returnosid.course.chronicle.batch.AssessmentEntryBatchFormListthe assessment entry forms
ErrorsNOT_FOUNDan assessmentId or stuidentId is not found
NULL_ARGUMENT peers or assessmentEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAssessmentEntries
Description

Creates a new set of AssessmentEntries. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.course.chronicle.batch.AssessmentEntryBatchFormListassessmentEntryFormsthe assessment entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT assessmentEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntryFormsForUpdate
Description

Gets the assessment entry forms for updating an existing set of assessment entries. A new assessment entry form should be requested for each update transaction.

Parametersosid.id.IdListassessmentEntryIdsthe Ids of the AssessmentEntry
Returnosid.course.chronicle.batch.AssessmentEntryBatchFormListthe assessment entry form
ErrorsNOT_FOUNDanassessment EntryId is not found
NULL_ARGUMENT assessmentEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAssessmentEntries
Description

Updates existing assessment entries. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.course.chronicle.batch.AssessmentEntryBatchFormListassessmentEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT assessmentEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAssessmentEntries
Description

Deletes all AssessmentEntries in this CourseCatalog .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssessmentEntries
Description

Deletes assessment entries for the given Ids.

Parametersosid.id.IdListassessmentEntryIdsthe Ids of the assessment entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assessmentEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssessmentEntriesForAssessment
Description

Deletes all assessment entries for the given assessment.

Parametersosid.id.IdassessmentIdan Id of an assessment
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssessmentEntriesForStudent
Description

Deletes all assessment entries for the given student.

Parametersosid.id.IdresourceIdan Id of a student
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveAssessmentEntriesByDate
Description

Deletes assessment entries expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAssessmentEntries
Description

Adds an 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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.