org.osid.course.batch

Interface ActivityUnitBatchAdminSession

All Superinterfaces:

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

public interface ActivityUnitBatchAdminSession
extends ActivityUnitAdminSession

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

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

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

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

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

The delete operations delete ActivityUnits in bulk. To unmap an ActivityUnit from the current CourseCatalog, the ActivityUnitCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ActivityUnit 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	aliasActivityUnits(AliasRequestList aliasRequests) Adds an Id to an ActivityUnit for the purpose of creating compatibility.
CreateResponseList	createActivityUnits(ActivityUnitBatchFormList activityUnitForms) Creates a new set of ActivityUnits.
DeleteResponseList	deleteActivityUnits(IdList activityUnitIds) Deletes activity units for the given Ids.
DeleteResponseList	deleteActivityUnitsForCourse(Id courseId) Deletes all activity units mapped to the given course.
DeleteResponseList	deleteAllActivityUnits() Deletes all ActivityUnits in this CourseCatalog .
ActivityUnitBatchFormList	getActivityUnitFormsForCreate(IdList courseIds, Type[] activityUnitRecordTypes) Gets the activity unitforms for creating a bunch of new activity units.
ActivityUnitBatchFormList	getActivityUnitFormsForUpdate(IdList activityUnitIds) Gets the activity unit forms for updating an existing set of activity units.
UpdateResponseList	updateActivityUnits(ActivityUnitBatchFormList activityUnitForms) Updates existing activity units.

Methods inherited from interface org.osid.course.ActivityUnitAdminSession

aliasActivityUnit, canCreateActivityUnits, canCreateActivityUnitWithRecordTypes, canDeleteActivityUnits, canManageActivityUnitAliases, canUpdateActivityUnits, createActivityUnit, deleteActivityUnit, getActivityUnitFormForCreate, getActivityUnitFormForUpdate, getCourseCatalog, getCourseCatalogId, updateActivityUnit

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

getActivityUnitFormsForCreate

ActivityUnitBatchFormList getActivityUnitFormsForCreate(IdList courseIds,
                                                      Type[] activityUnitRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the activity unitforms for creating a bunch of new activity units. A new activity form is returned for each supplied course.

Parameters:

courseIds - a list of course Ids

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

Returns:

the activity unitforms

Throws:

NotFoundException - a courseId is not found

NullArgumentException - courseIds or activityUnitRecordTypes 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.

createActivityUnits

CreateResponseList createActivityUnits(ActivityUnitBatchFormList activityUnitForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

activityUnitForms - the activity unit forms

Returns:

the create responses

Throws:

NullArgumentException - activityUnitForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnitFormsForUpdate

ActivityUnitBatchFormList getActivityUnitFormsForUpdate(IdList activityUnitIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the activity unit forms for updating an existing set of activity units. A new activity unitform should be requested for each update transaction.

Parameters:

activityUnitIds - the Ids of the ActivityUnit

Returns:

the activity unit form

Throws:

NotFoundException - an activityUnitId is not found

NullArgumentException - activityUnitIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateActivityUnits

UpdateResponseList updateActivityUnits(ActivityUnitBatchFormList activityUnitForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

activityUnitForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - activityUnitForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllActivityUnits

DeleteResponseList deleteAllActivityUnits()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all ActivityUnits in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityUnits

DeleteResponseList deleteActivityUnits(IdList activityUnitIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes activity units for the given Ids.

Parameters:

activityUnitIds - the Ids of the activity units to delete

Returns:

the delete responses

Throws:

NullArgumentException - activityUnitIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActivityUnitsForCourse

DeleteResponseList deleteActivityUnitsForCourse(Id courseId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes all activity units mapped to the given course.

Parameters:

courseId - an 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.

aliasActivityUnits

AliasResponseList aliasActivityUnits(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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