org.osid.course.chronicle.batch

Interface AssessmentEntryBatchAdminSession

All Superinterfaces:

AssessmentEntryAdminSession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.course.chronicle.AssessmentEntryAdminSession

aliasAssessmentEntry, canCreateAssessmentEntries, canCreateAssessmentEntryWithRecordTypes, canDeleteAssessmentEntries, canDeleteAssessmentEntry, canManageAssessmentEntryAliases, canUpdateAssessmentEntries, createAssessmentEntry, deleteAssessmentEntry, getAssessmentEntryFormForCreate, getAssessmentEntryFormForUpdate, getCourseCatalog, getCourseCatalogId, updateAssessmentEntry

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAssessmentEntryFormsForCreate

AssessmentEntryBatchFormList getAssessmentEntryFormsForCreate(AssessmentEntryPeerList peers,
                                                            Type[] assessmentEntryRecordTypes)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

peers - the relationship peers

assessmentEntryRecordTypes - array of assessment entry record types to be included in each create operation or an empty list if none

Returns:

the assessment entry forms

Throws:

NotFoundException - an assessmentId or stuidentId is not found

NullArgumentException - peers or assessmentEntryRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createAssessmentEntries

CreateResponseList createAssessmentEntries(AssessmentEntryBatchFormList assessmentEntryForms)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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 .

Parameters:

assessmentEntryForms - the assessment entry forms

Returns:

the create responses

Throws:

NullArgumentException - assessmentEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntryFormsForUpdate

AssessmentEntryBatchFormList getAssessmentEntryFormsForUpdate(IdList assessmentEntryIds)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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.

Parameters:

assessmentEntryIds - the Ids of the AssessmentEntry

Returns:

the assessment entry form

Throws:

NotFoundException - anassessment EntryId is not found

NullArgumentException - assessmentEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAssessmentEntries

UpdateResponseList updateAssessmentEntries(AssessmentEntryBatchFormList assessmentEntryForms)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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 .

Parameters:

assessmentEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - assessmentEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAssessmentEntries

DeleteResponseList deleteAllAssessmentEntries()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes all AssessmentEntries in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAssessmentEntries

DeleteResponseList deleteAssessmentEntries(IdList assessmentEntryIds)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes assessment entries for the given Ids.

Parameters:

assessmentEntryIds - the Ids of the assessment entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - assessmentEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAssessmentEntriesForAssessment

DeleteResponseList deleteAssessmentEntriesForAssessment(Id assessmentId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes all assessment entries for the given assessment.

Parameters:

assessmentId - an Id of an assessment

Returns:

the delete responses

Throws:

NullArgumentException - assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAssessmentEntriesForStudent

DeleteResponseList deleteAssessmentEntriesForStudent(Id resourceId)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Deletes all assessment entries for the given student.

Parameters:

resourceId - an Id of a student

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveAssessmentEntriesByDate

DeleteResponseList deleteIneffectiveAssessmentEntriesByDate(DateTime date)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Deletes assessment entries expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAssessmentEntries

AliasResponseList aliasAssessmentEntries(AliasRequestList aliasRequests)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.