org.osid.course.program.batch

Interface ProgramBatchAdminSession

All Superinterfaces:

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

public interface ProgramBatchAdminSession
extends ProgramAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPrograms(AliasRequestList aliasRequests) Adds an Id to a Program for the purpose of creating compatibility.
CreateResponseList	createPrograms(ProgramBatchFormList programForms) Creates a new set of Programs.
DeleteResponseList	deleteAllPrograms() Deletes all Programs in this CourseCatalog .
DeleteResponseList	deletePrograms(IdList programIds) Deletes programs for the given Ids.
ProgramBatchFormList	getProgramFormsForCreate(long number, Type[] programRecordTypes) Gets the program forms for creating a bunch of new programs.
ProgramBatchFormList	getProgramFormsForUpdate(IdList programIds) Gets the program forms for updating an existing set of programs.
UpdateResponseList	updatePrograms(ProgramBatchFormList programForms) Updates existing programs.

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

getProgramFormsForCreate

ProgramBatchFormList getProgramFormsForCreate(long number,
                                            Type[] programRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

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

Returns:

the program forms

Throws:

NullArgumentException - 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.

createPrograms

CreateResponseList createPrograms(ProgramBatchFormList programForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

programForms - the program forms

Returns:

the create responses

Throws:

NullArgumentException - programForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramFormsForUpdate

ProgramBatchFormList getProgramFormsForUpdate(IdList programIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

programIds - the Ids of the Program

Returns:

the program form

Throws:

NotFoundException - a programId is not found

NullArgumentException - programIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePrograms

UpdateResponseList updatePrograms(ProgramBatchFormList programForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

programForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - programForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPrograms

DeleteResponseList deleteAllPrograms()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Programs in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePrograms

DeleteResponseList deletePrograms(IdList programIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes programs for the given Ids.

Parameters:

programIds - the Ids of the programs to delete

Returns:

the delete responses

Throws:

NullArgumentException - programIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPrograms

AliasResponseList aliasPrograms(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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.

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.