org.osid.course.syllabus.batch

Interface ModuleBatchAdminSession

All Superinterfaces:

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

public interface ModuleBatchAdminSession
extends ModuleAdminSession

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

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

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

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

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

The delete operations delete Modules in bulk. To unmap s Module from the current CourseCatalog, the ModuleCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Module 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	aliasModules(AliasRequestList aliasRequests) Adds an Id to a Module for the purpose of creating compatibility.
CreateResponseList	createModules(ModuleBatchFormList moduleForms) Creates a new set of Modules.
DeleteResponseList	deleteAllModules() Deletes all Modules in this CourseCatalog .
DeleteResponseList	deleteModules(IdList moduleIds) Deletes modules for the given Ids.
DeleteResponseList	deleteModulesForSyllabus(Id syllabusId) Deletes modules for the given syllabus.
ModuleBatchFormList	getModuleFormsForCreate(IdList syllabusIds, Type[] moduleRecordTypes) Gets the module forms for creating a bunch of new modules.
ModuleBatchFormList	getModuleFormsForUpdate(IdList moduleIds) Gets the module forms for updating an existing set of modules.
UpdateResponseList	updateModules(ModuleBatchFormList moduleForms) Updates existing modules.

Methods inherited from interface org.osid.course.syllabus.ModuleAdminSession

aliasModule, canCreateModules, canCreateModuleWithRecordTypes, canDeleteModules, canManageModuleAliases, canSequenceModules, canUpdateModules, createModule, deleteModule, getCourseCatalog, getCourseCatalogId, getModuleFormForCreate, getModuleFormForUpdate, moveModuleAhead, moveModuleBehind, orderModules, updateModule

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

getModuleFormsForCreate

ModuleBatchFormList getModuleFormsForCreate(IdList syllabusIds,
                                          Type[] moduleRecordTypes)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the module forms for creating a bunch of new modules. A new form isreturned for each supplied syllabus.

Parameters:

syllabusIds - a list of syllabus Ids

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

Returns:

the module forms

Throws:

NotFoundException - a syllabusId is no found

NullArgumentException - syllabusIds or moduleRecordTypes 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.

createModules

CreateResponseList createModules(ModuleBatchFormList moduleForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Creates a new set of Modules. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

moduleForms - the module forms

Returns:

the create responses

Throws:

NullArgumentException - moduleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getModuleFormsForUpdate

ModuleBatchFormList getModuleFormsForUpdate(IdList moduleIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

moduleIds - the Ids of the Module

Returns:

the module form

Throws:

NotFoundException - a moduleId is not found

NullArgumentException - moduleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateModules

UpdateResponseList updateModules(ModuleBatchFormList moduleForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Updates existing modules. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

moduleForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - moduleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllModules

DeleteResponseList deleteAllModules()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Modules in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteModules

DeleteResponseList deleteModules(IdList moduleIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes modules for the given Ids.

Parameters:

moduleIds - the Ids of the modules to delete

Returns:

the delete responses

Throws:

NullArgumentException - moduleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteModulesForSyllabus

DeleteResponseList deleteModulesForSyllabus(Id syllabusId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes modules for the given syllabus.

Parameters:

syllabusId - the Id of a syllabus

Returns:

the delete responses

Throws:

NullArgumentException - syllabusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasModules

AliasResponseList aliasModules(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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