OSID Logo
OSID Specifications
course program batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.batch.ProgramOfferingBatchAdminSession
Implementsosid.course.program.ProgramAdminSession
Description

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

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

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

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

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

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

MethodgetProgramOfferingFormsForCreate
Description

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

Parametersosid.course.program.batch.ProgramOfferingPeerListpeersa list of course offering peers
osid.type.Type[]programOfferingRecordTypesarray of program record types to be included in each create operation or an empty list if none
Returnosid.course.program.batch.ProgramOfferingBatchFormListthe program offering forms
ErrorsNOT_FOUNDa programId or termId is not found
NULL_ARGUMENT peers or programRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateProgramOfferings
Description

Creates a new set of ProgramOfferings. 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.program.batch.ProgramOfferingBatchFormListprogramOfferingFormsthe program offering forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT programOfferingForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingFormsForUpdate
Description

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

Parametersosid.id.IdListprogramOfferingIdsthe Ids of the ProgramOffering
Returnosid.course.program.batch.ProgramOfferingBatchFormListthe program offering forms
ErrorsNOT_FOUNDa programOfferingId is not found
NULL_ARGUMENT programOfferingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProgramOfferings
Description

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

Deletes all ProgramOfferings in this CourseCatalog .

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

Deletes program offerings for the given Ids.

Parametersosid.id.IdListprogramOfferingIdsthe Ids of the program offerings to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT programOfferingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProgramOffeingsForProgram
Description

Deletes program offerings for the given program.

Parametersosid.id.IdprogramIdthe Id of a program
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProgramOfferingsForTerm
Description

Deletes programs 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.
MethodaliasProgramOfferings
Description

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