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

This session creates, updates, and deletes Programs 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 Program, a ProgramForm is requested using getProgramFormsForCreate() specifying the desired 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 ProgramForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProgramForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetProgramFormsForCreate
Description

Gets the program forms for creating a bunch of new programs.

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

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

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

Parametersosid.id.IdListprogramIdsthe Ids of the Program
Returnosid.course.program.batch.ProgramBatchFormListthe program form
ErrorsNOT_FOUNDa programId is not found
NULL_ARGUMENT programIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePrograms
Description

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

Deletes all Programs in this CourseCatalog .

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

Deletes programs for the given Ids.

Parametersosid.id.IdListprogramIdsthe Ids of the programs to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT programIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPrograms
Description

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