OSID Logo
OSID Specifications
course syllabus batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.batch.SyllabusBatchAdminSession
Implementsosid.course.syllabus.SyllabusAdminSession
Description

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

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

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

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

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

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

MethodgetSyllabusFormsForCreate
Description

Gets the syllabus forms for creating a bunch of new syllabi. A new form is returned for each supplied course.

Parametersosid.id.IdListcourseIdsa list of course Ids
osid.type.Type[]syllabusRecordTypesarray of syllabus record types to be included in each create operation or an empty list if none
Returnosid.course.syllabus.batch.SyllabusBatchFormListthe syllabus forms
ErrorsNOT_FOUNDa courseId is not found
NULL_ARGUMENT courseIds or syllabusRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateSyllabi
Description

Creates a new set of Syllabi. 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.syllabus.batch.SyllabusBatchFormListsyllabusFormsthe syllabus forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT syllabusForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabusFormsForUpdate
Description

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

Parametersosid.id.IdListsyllabusIdsthe Ids of the Syllabus
Returnosid.course.syllabus.batch.SyllabusBatchFormListthe syllabus form
ErrorsNOT_FOUNDa syllabusId is not found
NULL_ARGUMENT syllabusIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateSyllabi
Description

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

Deletes all Syllabi in this CourseCatalog .

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

Deletes syllabi for the given Ids.

Parametersosid.id.IdListsyllabusIdsthe Ids of the syllabi to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT syllabusIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteSyllabiForCourse
Description

Deletes syllabi for the given course.

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

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