org.osid.course.registration.batch

Interface ActivityBundleBatchAdminSession

All Superinterfaces:

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

public interface ActivityBundleBatchAdminSession
extends ActivityBundleAdminSession

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

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

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

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

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

The delete operations delete ActivityBundles in bulk. To unmap a ActivityBundle from the current CourseCatalog, the ActivityBundleCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ActivityBundle 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	aliasActivityBundles(AliasRequestList aliasRequests) Adds an Id to a ActivityBundle for the purpose of creating compatibility.
CreateResponseList	createActivityBundles(ActivityBundleBatchFormList activityBundleForms) Creates a new set of ActivityBundles.
DeleteResponseList	deleteActivityBundles(IdList activityBundleIds) Deletes actvity bundles for the given Ids.
DeleteResponseList	deleteActivityBundlesByActivityOffering(Id activityOfferingId) Deletes actvity bundles containing the given activity offering.
DeleteResponseList	deleteActivityBundlesForCourseOffering(Id courseOfferingId) Deletes actvity bundles for the given course offering.
DeleteResponseList	deleteAllActivityBundles() Deletes all ActivityBundles in this CourseCatalog .
ActivityBundleBatchFormList	getActivityBundleFormsForCreate(IdList courseOfferingIds, Type[] activityBundleRecordTypes) Gets the activity bundle forms for creating a bunch of new actvity bundles.
ActivityBundleBatchFormList	getActivityBundleFormsForUpdate(IdList activityBundleIds) Gets the activity bundle forms for updating an existing set of actvity bundles.
UpdateResponseList	updateActivityBundles(ActivityBundleBatchFormList activityBundleForms) Updates existing actvity bundles.

Methods inherited from interface org.osid.course.registration.ActivityBundleAdminSession

aliasActivityBundle, canCreateActivityBundles, canCreateActivityBundlesForCourseOffering, canCreateActivityBundleWithRecordTypes, canDeleteActivityBundles, canManageActivityBundleAliases, canUpdateActivityBundles, createActivityBundle, deleteActivityBundle, getActivityBundleFormForCreate, getActivityBundleFormForUpdate, getCourseCatalog, getCourseCatalogId, updateActivityBundle

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

getActivityBundleFormsForCreate

ActivityBundleBatchFormList getActivityBundleFormsForCreate(IdList courseOfferingIds,
                                                          Type[] activityBundleRecordTypes)
                                                            throws NotFoundException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Gets the activity bundle forms for creating a bunch of new actvity bundles. An ActivityBundleForm is returned for each supplied course offering.

Parameters:

courseOfferingIds - a list of course offering Ids

activityBundleRecordTypes - array of activity bundle record types to be included in each create operation or an empty list if none

Returns:

the activity bundle forms

Throws:

NotFoundException - a courseOfferingId is not found

NullArgumentException - courseOfferingIds or activityBundleRecordTypes 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.

createActivityBundles

CreateResponseList createActivityBundles(ActivityBundleBatchFormList activityBundleForms)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

activityBundleForms - the activity bundle forms

Returns:

the create responses

Throws:

NullArgumentException - activityBundleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundleFormsForUpdate

ActivityBundleBatchFormList getActivityBundleFormsForUpdate(IdList activityBundleIds)
                                                            throws NotFoundException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Gets the activity bundle forms for updating an existing set of actvity bundles. A new activity bundle form should be requested for each update transaction.

Parameters:

activityBundleIds - the Ids of the ActivityBundle

Returns:

the activity bundle form

Throws:

NotFoundException - a activityBundleId is not found

NullArgumentException - activityBundleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateActivityBundles

UpdateResponseList updateActivityBundles(ActivityBundleBatchFormList activityBundleForms)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

activityBundleForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - activityBundleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllActivityBundles

DeleteResponseList deleteAllActivityBundles()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes all ActivityBundles in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityBundles

DeleteResponseList deleteActivityBundles(IdList activityBundleIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes actvity bundles for the given Ids.

Parameters:

activityBundleIds - the Ids of the actvity bundles to delete

Returns:

the delete responses

Throws:

NullArgumentException - activityBundleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityBundlesForCourseOffering

DeleteResponseList deleteActivityBundlesForCourseOffering(Id courseOfferingId)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Deletes actvity bundles for the given course offering.

Parameters:

courseOfferingId - the Id of a course offering

Returns:

the delete responses

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityBundlesByActivityOffering

DeleteResponseList deleteActivityBundlesByActivityOffering(Id activityOfferingId)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

Deletes actvity bundles containing the given activity offering.

Parameters:

activityOfferingId - the Id of an activity offering

Returns:

the delete responses

Throws:

NullArgumentException - activityOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasActivityBundles

AliasResponseList aliasActivityBundles(AliasRequestList aliasRequests)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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