| Interface | osid.course.program.batch.ProgramOfferingBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.program.ProgramAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getProgramOfferingFormsForCreate | ||
| 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.  | ||
| Parameters | osid.course.program.batch.ProgramOfferingPeerList | peers | a list of course offering peers | 
osid.type.Type[] | programOfferingRecordTypes | array of program record types to be included in each create operation or an empty list if none | |
| Return | osid.course.program.batch.ProgramOfferingBatchFormList | the program offering forms | |
| Errors | NOT_FOUND | a  programId  or  termId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  programRecordTypes  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createProgramOfferings | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.course.program.batch.ProgramOfferingBatchFormList | programOfferingForms | the program offering forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  programOfferingForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramOfferingFormsForUpdate | ||
| 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.  | ||
| Parameters | osid.id.IdList | programOfferingIds | the  Ids  of the  ProgramOffering   | 
| Return | osid.course.program.batch.ProgramOfferingBatchFormList | the program offering forms | |
| Errors | NOT_FOUND | a  programOfferingId  is not found  |                 |
| NULL_ARGUMENT |  programOfferingIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateProgramOfferings | ||
| 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   | ||
| Parameters | osid.course.program.batch.ProgramOfferingBatchFormList | programOfferingForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  programOfferingForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllProgramOfferings | ||
| Description | 
                     Deletes all   | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProgramOfferings | ||
| Description | 
                     Deletes program offerings for the given   | ||
| Parameters | osid.id.IdList | programOfferingIds | the  Ids  of the program offerings to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  programOfferingIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProgramOffeingsForProgram | ||
| Description | 
                     Deletes program offerings for the given program.  | ||
| Parameters | osid.id.Id | programId | the  Id  of a program  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  programId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProgramOfferingsForTerm | ||
| Description | 
                     Deletes programs for the given term.  | ||
| Parameters | osid.id.Id | termId | the  Id  of a term  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  termId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasProgramOfferings | ||
| Description | 
                     Adds an   | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests | 
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT |  aliasRequests  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |