org.osid.course.batch

Interface CourseCatalogBatchAdminSession

All Superinterfaces:

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

public interface CourseCatalogBatchAdminSession
extends CourseCatalogAdminSession

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

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

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

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

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

The delete operations delete CourseCatalogs in bulk. To unmap a CourseCatalog from the current Calendar, the CourseCatalogCalendarAssignmentSession should be used. These delete operations attempt to remove the CourseCatalog itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCourseCatalogs(AliasRequestList aliasRequests) Adds an Id to a CourseCatalog for the purpose of creating compatibility.
CreateResponseList	createCourseCatalogs(CourseCatalogBatchFormList courseCatalogForms) Creates a new set of CourseCatalogs.
DeleteResponseList	deleteAllCourseCatalogs() Deletes all CourseCatalogs in this Calendar .
DeleteResponseList	deleteCourseCatalogs(IdList courseCatalogIds) Deletes course catalogs for the given Ids.
CourseCatalogBatchFormList	getCourseCatalogFormsForCreate(long number, Type[] courseCatalogRecordTypes) Gets the course catalog forms for creating a bunch of new course catalogs.
CourseCatalogBatchFormList	getCourseCatalogFormsForUpdate(IdList courseCatalogIds) Gets the course catalog forms for updating an existing set of course catalogs.
UpdateResponseList	updateCourseCatalogs(CourseCatalogBatchFormList courseCatalogForms) Updates existing course catalogs.

Methods inherited from interface org.osid.course.CourseCatalogAdminSession

aliasCourseCatalog, canCreateCourseCatalogs, canCreateCourseCatalogWithRecordTypes, canDeleteCourseCatalogs, canManageCourseCatalogAliases, canUpdateCourseCatalogs, createCourseCatalog, deleteCourseCatalog, getCourseCatalogFormForCreate, getCourseCatalogFormForUpdate, updateCourseCatalog

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

getCourseCatalogFormsForCreate

CourseCatalogBatchFormList getCourseCatalogFormsForCreate(long number,
                                                        Type[] courseCatalogRecordTypes)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets the course catalog forms for creating a bunch of new course catalogs.

Parameters:

number - the number of forms to retrieve

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

Returns:

the course catalog forms

Throws:

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

createCourseCatalogs

CreateResponseList createCourseCatalogs(CourseCatalogBatchFormList courseCatalogForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

courseCatalogForms - the course catalog forms

Returns:

the create responses

Throws:

NullArgumentException - courseCatalogForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogFormsForUpdate

CourseCatalogBatchFormList getCourseCatalogFormsForUpdate(IdList courseCatalogIds)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

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

Parameters:

courseCatalogIds - the Ids of the CourseCatalog

Returns:

the course catalog form

Throws:

NotFoundException - a courseCatalogId is not found

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCourseCatalogs

UpdateResponseList updateCourseCatalogs(CourseCatalogBatchFormList courseCatalogForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

courseCatalogForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - courseCatalogForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCourseCatalogs

DeleteResponseList deleteAllCourseCatalogs()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all CourseCatalogs in this Calendar .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCourseCatalogs

DeleteResponseList deleteCourseCatalogs(IdList courseCatalogIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes course catalogs for the given Ids.

Parameters:

courseCatalogIds - the Ids of the course catalogs to delete

Returns:

the delete responses

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCourseCatalogs

AliasResponseList aliasCourseCatalogs(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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