OSID Logo
OSID Specifications
course batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.batch.CourseOfferingBatchAdminSession
Implementsosid.course.CourseOfferingAdminSession
Description

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

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

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

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

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

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

MethodgetCourseOfferingFormsForCreate
Description

Gets the course offering forms for creating a bunch of new course offerings. A form is returned for each canonical course and term pair.

Parametersosid.course.batch.CourseOfferingPeerListpeersthe relationship peers
osid.type.Type[]courseOfferingRecordTypesarray of course offering record types to be included in each create operation or an empty list if none
Returnosid.course.batch.CourseOfferingBatchFormListthe course offering forms
ErrorsNOT_FOUNDa courseId or termId is not found
NULL_ARGUMENT peers or courseOfferingRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCourseOfferings
Description

Creates a new set of CourseOfferings. 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.batch.CourseOfferingBatchFormListcourseOfferingFormsthe course offering forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT courseOfferingForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingFormsForUpdate
Description

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

Parametersosid.id.IdListcourseOfferingIdsthe Ids of the CourseOffering
Returnosid.course.batch.CourseOfferingBatchFormListthe course offering form
ErrorsNOT_FOUNDa courseOfferingId is not found
NULL_ARGUMENT courseOfferingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCourseOfferings
Description

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

Deletes all CourseOfferings in this CourseCatalog .

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

Deletes course offerings for the given Ids.

Parametersosid.id.IdListcourseOfferingIdsthe Ids of the course offerings to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseOfferingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCourseOfferingsForCourse
Description

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

Deletes course offerings for the given term.

Parametersosid.id.IdtermIdthe Id of a term
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCourseOfferingsForCourseAndTerm
Description

Deletes course offerings for the given course and term.

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

Deletes course offerings ineffective 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.
MethodaliasCourseOfferings
Description

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