OSID Logo
OSID Specifications
course batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.batch.ActivityUnitBatchAdminSession
Implementsosid.course.ActivityUnitAdminSession
Description

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.

MethodgetActivityUnitFormsForCreate
Description

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

Parametersosid.id.IdListcourseIdsa list of course Ids
osid.type.Type[]activityUnitRecordTypesarray of activity unit record types to be included in each create operation or an empty list if none
Returnosid.course.batch.ActivityUnitBatchFormListthe activity unitforms
ErrorsNOT_FOUNDa courseId is not found
NULL_ARGUMENT courseIds or activityUnitRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateActivityUnits
Description

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 .

Parametersosid.course.batch.ActivityUnitBatchFormListactivityUnitFormsthe activity unit forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT activityUnitForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitFormsForUpdate
Description

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

Parametersosid.id.IdListactivityUnitIdsthe Ids of the ActivityUnit
Returnosid.course.batch.ActivityUnitBatchFormListthe activity unit form
ErrorsNOT_FOUNDan activityUnitId is not found
NULL_ARGUMENT activityUnitIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateActivityUnits
Description

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 .

Parametersosid.course.batch.ActivityUnitBatchFormListactivityUnitFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT activityUnitForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllActivityUnits
Description

Deletes all ActivityUnits in this CourseCatalog .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteActivityUnits
Description

Deletes activity units for the given Ids.

Parametersosid.id.IdListactivityUnitIdsthe Ids of the activity units to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT activityUnitIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteActivityUnitsForCourse
Description

Deletes all activity units mapped to the given course.

Parametersosid.id.IdcourseIdan Id of a course
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasActivityUnits
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.