org.osid.course.program.batch

Interface ProgramOfferingBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ProgramAdminSession

public interface ProgramOfferingBatchAdminSession
extends ProgramAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProgramOfferings(AliasRequestList aliasRequests) Adds an Id to a ProgramOffering for the purpose of creating compatibility.
CreateResponseList	createProgramOfferings(ProgramOfferingBatchFormList programOfferingForms) Creates a new set of ProgramOfferings.
DeleteResponseList	deleteAllProgramOfferings() Deletes all ProgramOfferings in this CourseCatalog .
DeleteResponseList	deleteProgramOffeingsForProgram(Id programId) Deletes program offerings for the given program.
DeleteResponseList	deleteProgramOfferings(IdList programOfferingIds) Deletes program offerings for the given Ids.
DeleteResponseList	deleteProgramOfferingsForTerm(Id termId) Deletes programs for the given term.
ProgramOfferingBatchFormList	getProgramOfferingFormsForCreate(ProgramOfferingPeerList peers, Type[] programOfferingRecordTypes) Gets the program offering forms for creating a bunch of new program offerings.
ProgramOfferingBatchFormList	getProgramOfferingFormsForUpdate(IdList programOfferingIds) Gets the program offering forms for updating an existing set of program offerings.
UpdateResponseList	updateProgramOfferings(ProgramOfferingBatchFormList programOfferingForms) Updates existing program offerings.

Methods inherited from interface org.osid.course.program.ProgramAdminSession

aliasProgram, canCreatePrograms, canCreateProgramWithRecordTypes, canDeletePrograms, canManageProgramAliases, canUpdatePrograms, createProgram, deleteProgram, getCourseCatalog, getCourseCatalogId, getProgramFormForCreate, getProgramFormForUpdate, updateProgram

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getProgramOfferingFormsForCreate

ProgramOfferingBatchFormList getProgramOfferingFormsForCreate(ProgramOfferingPeerList peers,
                                                            Type[] programOfferingRecordTypes)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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:

peers - a list of course offering peers

programOfferingRecordTypes - array of program record types to be included in each create operation or an empty list if none

Returns:

the program offering forms

Throws:

NotFoundException - a programId or termId is not found

NullArgumentException - peers or programRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createProgramOfferings

CreateResponseList createProgramOfferings(ProgramOfferingBatchFormList programOfferingForms)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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 .

Parameters:

programOfferingForms - the program offering forms

Returns:

the create responses

Throws:

NullArgumentException - programOfferingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingFormsForUpdate

ProgramOfferingBatchFormList getProgramOfferingFormsForUpdate(IdList programOfferingIds)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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:

programOfferingIds - the Ids of the ProgramOffering

Returns:

the program offering forms

Throws:

NotFoundException - a programOfferingId is not found

NullArgumentException - programOfferingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProgramOfferings

UpdateResponseList updateProgramOfferings(ProgramOfferingBatchFormList programOfferingForms)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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 .

Parameters:

programOfferingForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - programOfferingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProgramOfferings

DeleteResponseList deleteAllProgramOfferings()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes all ProgramOfferings in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProgramOfferings

DeleteResponseList deleteProgramOfferings(IdList programOfferingIds)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes program offerings for the given Ids.

Parameters:

programOfferingIds - the Ids of the program offerings to delete

Returns:

the delete responses

Throws:

NullArgumentException - programOfferingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProgramOffeingsForProgram

DeleteResponseList deleteProgramOffeingsForProgram(Id programId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes program offerings for the given program.

Parameters:

programId - the Id of a program

Returns:

the delete responses

Throws:

NullArgumentException - programId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProgramOfferingsForTerm

DeleteResponseList deleteProgramOfferingsForTerm(Id termId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes programs for the given term.

Parameters:

termId - the Id of a term

Returns:

the delete responses

Throws:

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasProgramOfferings

AliasResponseList aliasProgramOfferings(AliasRequestList aliasRequests)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.