org.osid.course.batch

Interface CourseBatchAdminSession

All Superinterfaces:

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

public interface CourseBatchAdminSession
extends CourseAdminSession

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

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

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

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

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

The delete operations delete Courses in bulk. To unmap a Course from the current CourseCatalog, the CourseCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Course 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	aliasCourses(AliasRequestList aliasRequests) Adds an Id to a Course for the purpose of creating compatibility.
CreateResponseList	createCourses(CourseBatchFormList courseForms) Creates a new set of Courses.
DeleteResponseList	deleteAllCourses() Deletes all Courses in this CourseCatalog .
DeleteResponseList	deleteCourses(IdList courseIds) Deletes courses for the given Ids.
CourseBatchFormList	getCourseFormsForCreate(long number, Type[] courseRecordTypes) Gets the course forms for creating a bunch of new courses.
CourseBatchFormList	getCourseFormsForUpdate(IdList courseIds) Gets the course forms for updating an existing set of courses.
UpdateResponseList	updateCourses(CourseBatchFormList courseForms) Updates existing courses.

Methods inherited from interface org.osid.course.CourseAdminSession

aliasCourse, canCreateCourses, canCreateCourseWithRecordTypes, canDeleteCourses, canManageCourseAliases, canUpdateCourses, createCourse, deleteCourse, getCourseCatalog, getCourseCatalogId, getCourseFormForCreate, getCourseFormForUpdate, updateCourse

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

getCourseFormsForCreate

CourseBatchFormList getCourseFormsForCreate(long number,
                                          Type[] courseRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets the course forms for creating a bunch of new courses.

Parameters:

number - the number of forms to retrieve

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

Returns:

the course forms

Throws:

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

createCourses

CreateResponseList createCourses(CourseBatchFormList courseForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

courseForms - the course forms

Returns:

the create responses

Throws:

NullArgumentException - courseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseFormsForUpdate

CourseBatchFormList getCourseFormsForUpdate(IdList courseIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

courseIds - the Ids of the Course

Returns:

the course form

Throws:

NotFoundException - a courseId is not found

NullArgumentException - courseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCourses

UpdateResponseList updateCourses(CourseBatchFormList courseForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

courseForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - courseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCourses

DeleteResponseList deleteAllCourses()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Courses in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCourses

DeleteResponseList deleteCourses(IdList courseIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes courses for the given Ids.

Parameters:

courseIds - the Ids of the courses to delete

Returns:

the delete responses

Throws:

NullArgumentException - courseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCourses

AliasResponseList aliasCourses(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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