org.osid.course.batch

Interface CourseOfferingBatchAdminSession

All Superinterfaces:

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

public interface CourseOfferingBatchAdminSession
extends CourseOfferingAdminSession

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

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

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

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

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

The delete operations delete CourseOfferings in bulk. To unmap a CourseOffering from the current CourseCatalog, the CourseOfferingCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the CourseOffering 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	aliasCourseOfferings(AliasRequestList aliasRequests) Adds an Id to a CourseOffering for the purpose of creating compatibility.
CreateResponseList	createCourseOfferings(CourseOfferingBatchFormList courseOfferingForms) Creates a new set of CourseOfferings.
DeleteResponseList	deleteAllCourseOfferings() Deletes all CourseOfferings in this CourseCatalog .
DeleteResponseList	deleteCourseOfferings(IdList courseOfferingIds) Deletes course offerings for the given Ids.
DeleteResponseList	deleteCourseOfferingsForCourse(Id courseId) Deletes course offerings for the given course.
DeleteResponseList	deleteCourseOfferingsForCourseAndTerm(Id courseId, Id termId) Deletes course offerings for the given course and term.
DeleteResponseList	deleteCourseOfferingsForTerm(Id termId) Deletes course offerings for the given term.
DeleteResponseList	deleteIneffectiveCourseOfferingsByDate(DateTime date) Deletes course offerings ineffective before the given date.
CourseOfferingBatchFormList	getCourseOfferingFormsForCreate(CourseOfferingPeerList peers, Type[] courseOfferingRecordTypes) Gets the course offering forms for creating a bunch of new course offerings.
CourseOfferingBatchFormList	getCourseOfferingFormsForUpdate(IdList courseOfferingIds) Gets the course offering forms for updating an existing set of course offerings.
UpdateResponseList	updateCourseOfferings(CourseOfferingBatchFormList courseOfferingForms) Updates existing course offerings.

Methods inherited from interface org.osid.course.CourseOfferingAdminSession

aliasCourseOffering, canCreateCourseOfferings, canCreateCourseOfferingWithRecordTypes, canDeleteCourseOfferings, canManageCourseOfferingAliases, canUpdateCourseOfferings, createCourseOffering, deleteCourseOffering, getCourseCatalog, getCourseCatalogId, getCourseOfferingFormForCreate, getCourseOfferingFormForUpdate, updateCourseOffering

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

getCourseOfferingFormsForCreate

CourseOfferingBatchFormList getCourseOfferingFormsForCreate(CourseOfferingPeerList peers,
                                                          Type[] courseOfferingRecordTypes)
                                                            throws NotFoundException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Gets the course offering forms for creating a bunch of new course offerings. A form is returned for each canonical course and term pair.

Parameters:

peers - the relationship peers

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

Returns:

the course offering forms

Throws:

NotFoundException - a courseId or termId is not found

NullArgumentException - peers or courseOfferingRecordTypes 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.

createCourseOfferings

CreateResponseList createCourseOfferings(CourseOfferingBatchFormList courseOfferingForms)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

courseOfferingForms - the course offering forms

Returns:

the create responses

Throws:

NullArgumentException - courseOfferingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseOfferingFormsForUpdate

CourseOfferingBatchFormList getCourseOfferingFormsForUpdate(IdList courseOfferingIds)
                                                            throws NotFoundException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

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

Parameters:

courseOfferingIds - the Ids of the CourseOffering

Returns:

the course offering form

Throws:

NotFoundException - a courseOfferingId is not found

NullArgumentException - courseOfferingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCourseOfferings

UpdateResponseList updateCourseOfferings(CourseOfferingBatchFormList courseOfferingForms)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Updates existing course 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:

courseOfferingForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - courseOfferingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCourseOfferings

DeleteResponseList deleteAllCourseOfferings()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes all CourseOfferings in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCourseOfferings

DeleteResponseList deleteCourseOfferings(IdList courseOfferingIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes course offerings for the given Ids.

Parameters:

courseOfferingIds - the Ids of the course offerings to delete

Returns:

the delete responses

Throws:

NullArgumentException - courseOfferingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCourseOfferingsForCourse

DeleteResponseList deleteCourseOfferingsForCourse(Id courseId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes course offerings for the given course.

Parameters:

courseId - the Id of a course

Returns:

the delete responses

Throws:

NullArgumentException - courseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCourseOfferingsForTerm

DeleteResponseList deleteCourseOfferingsForTerm(Id termId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes course offerings 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.

deleteCourseOfferingsForCourseAndTerm

DeleteResponseList deleteCourseOfferingsForCourseAndTerm(Id courseId,
                                                       Id termId)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Deletes course offerings for the given course and term.

Parameters:

courseId - the Id of a course

termId - the Id of a term

Returns:

the delete responses

Throws:

NullArgumentException - courseId or termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveCourseOfferingsByDate

DeleteResponseList deleteIneffectiveCourseOfferingsByDate(DateTime date)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Deletes course offerings ineffective before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCourseOfferings

AliasResponseList aliasCourseOfferings(AliasRequestList aliasRequests)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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