OSID Logo
OSID Specifications
course chronicle batch package
Version 3.1.0
Interfaceosid.course.chronicle.batch.AwardEntryBatchAdminSession
Implementsosid.course.chronicle.AwardEntryAdminSession
Used Byosid.course.chronicle.batch.CourseChronicleBatchManager
osid.course.chronicle.batch.CourseChronicleBatchProxyManager
Description

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.

MethodgetAwardEntryFormsForCreate
Description

Gets the award entry forms for creating a bunch of new award entries. A form is returned for each award and student pair.

Parametersosid.course.chronicle.batch.AwardEntryPeerListpeers the relationship peers
osid.type.Type[]awardEntryRecordTypes array of award entry record types to be included in each create operation or an empty list if none
Returnosid.course.chronicle.batch.AwardEntryBatchFormList the award entry forms
ErrorsNOT_FOUND an awardId or studentId is not found
NULL_ARGUMENT peers or awardEntryRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateAwardEntries
Description

Creates a new set of AwardEntries. 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.AwardEntryBatchFormListawardEntryForms the award entry forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT awardEntryForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetAwardEntryFormsForUpdate
Description

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

Parametersosid.id.IdListawardEntryIds the Ids of the AwardEntry
Returnosid.course.chronicle.batch.AwardEntryBatchFormList the award entry form
ErrorsNOT_FOUND an awardEntryId is not found
NULL_ARGUMENT awardEntryIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateAwardEntries
Description

Updates existing award 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.AwardEntryBatchFormListawardEntryForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT awardEntryForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllAwardEntries
Description

Deletes all AwardEntries in this CourseCatalog.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAwardEntries
Description

Deletes award entries for the given Ids.

Parametersosid.id.IdListawardEntryIds the Ids of the award entries to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT awardEntryIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAwardEntriesForAward
Description

Deletes award entries for the given award.

Parametersosid.id.IdListawardId an Id of an award
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAwardEntriesForStudent
Description

Deletes award entries for the given student.

Parametersosid.id.IdListresourceId an Id of a student
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteIneffectiveAwardEntriesByDate
Description

Deletes award entries expired before the given date.

Parametersosid.calendaring.DateTimedate a date
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasAwardEntries
Description

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

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.