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

This session creates, updates, and deletes CourseEntries 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 CourseEntry, a CourseEntryForm is requested using getCourseEntryFormsForCreate() specifying the desired course, student and record Types or none if no record Types are needed. Each of the returned CourseEntryForms 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 CourseEntryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CourseEntryForm corresponds to an attempted transaction.

The CourseEntryForms returned from getCourseEntryFormsForCreate() may be linked to the originating request through the peer Ids of the CourseEntryForm. In the case where there may be duplicates, any CourseEntryForm of the same peer Ids may be used for a create operation.

Once a batch of CourseEntryForms are submitted for create, a CreateResponse is returned for each CourseEntryForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createCourseEntries(), errors specific to an individual CourseEntryForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating CourseEntryForm through the CourseEntryForm Id .

For updates, CourseEntryForms are requested to the CourseEntry Id that is to be updated using getCourseEntryFormsForUpdate() where the reference Id in the CourseEntryForm may be used to link the request. Similarly, the CourseEntryForm has metadata about the data that can be updated and it can perform validation before submitting the update. The CourseEntryForm can only be used once for a successful update and cannot be reused.

Once a batch of CourseEntryForms are submitted for update, an UpdateResponse is returned for each CourseEntryForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateCourseEntries(), errors specific to an individual CourseEntryForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating CourseEntryForm through the CourseEntryForm Id.

The delete operations delete CourseEntries in bulk. To unmap a CourseEntry from the current CourseCatalog, the CourseEntryCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the CourseEntry itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetCourseEntryFormsForCreate
Description

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

Parametersosid.course.chronicle.batch.CourseEntryPeerListpeersthe relationship peers
osid.type.Type[]courseEntryRecordTypesarray of course entry record types to be included in each create operation or an empty list if none
Returnosid.course.chronicle.batch.CourseEntryBatchFormListthe course entry forms
ErrorsNOT_FOUNDa courseId or resourceId is not found
NULL_ARGUMENT peers or courseEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCourseEntries
Description

Creates a new set of CourseEntries. 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.CourseEntryBatchFormListcourseEntryFormsthe course entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT courseEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntryFormsForUpdate
Description

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

Parametersosid.id.IdListcourseEntryIdsthe Ids of the CourseEntry
Returnosid.course.chronicle.batch.CourseEntryBatchFormListthe course entry form
ErrorsNOT_FOUNDa courseEntryId is not found
NULL_ARGUMENT courseEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCourseEntries
Description

Updates existing course 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.CourseEntryBatchFormListcourseEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT courseEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCourseEntries
Description

Deletes all CourseEntries in this CourseCatalog .

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

Deletes course entries for the given Ids.

Parametersosid.id.IdListcourseEntryIdsthe Ids of the course entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCourseEntriesForCourse
Description

Deletes course entries for the given course.

Parametersosid.id.IdcourseIdthe Id of a course
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCourseEntriesForStudent
Description

Deletes course entries for the given student.

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

Deletes course 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.
MethodaliasCourseEntries
Description

Adds an Id to a CourseEntry for the purpose of creating compatibility. The primary Id of the CourseEntry is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another course entry, it is reassigned to the given course 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.