OSID Logo
OSID Specifications
course batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.batch.CourseBatchAdminSession
Implementsosid.course.CourseAdminSession
Description

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

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

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

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

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

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

MethodgetCourseFormsForCreate
Description

Gets the course forms for creating a bunch of new courses.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]courseRecordTypesarray of course record types to be included in each create operation or an empty list if none
Returnosid.course.batch.CourseBatchFormListthe course forms
ErrorsNULL_ARGUMENT courseRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCourses
Description

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

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

Parametersosid.id.IdListcourseIdsthe Ids of the Course
Returnosid.course.batch.CourseBatchFormListthe course form
ErrorsNOT_FOUNDa courseId is not found
NULL_ARGUMENT courseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCourses
Description

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

Deletes all Courses in this CourseCatalog .

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

Deletes courses for the given Ids.

Parametersosid.id.IdListcourseIdsthe Ids of the courses to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCourses
Description

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