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.
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.
|
aliasActivityUnit, canCreateActivityUnits, canCreateActivityUnitWithRecordTypes, canDeleteActivityUnits, canManageActivityUnitAliases, canUpdateActivityUnits, createActivityUnit, deleteActivityUnit, getActivityUnitFormForCreate, getActivityUnitFormForUpdate, getCourseCatalog, getCourseCatalogId, updateActivityUnit
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActivityUnitBatchFormList getActivityUnitFormsForCreate(IdList courseIds, Type[] activityUnitRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 noneNotFoundException
- a courseId
is not
foundNullArgumentException
- courseIds
or
activityUnitRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createActivityUnits(ActivityUnitBatchFormList activityUnitForms) throws OperationFailedException, PermissionDeniedException
ActivityUnits.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.activityUnitForms
- the activity unit formsNullArgumentException
- activityUnitForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityUnitBatchFormList getActivityUnitFormsForUpdate(IdList activityUnitIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityUnitIds
- the Ids
of the
ActivityUnit
NotFoundException
- an activityUnitId
is
not foundNullArgumentException
- activityUnitIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateActivityUnits(ActivityUnitBatchFormList activityUnitForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.activityUnitForms
- the form containing the elements to be
updatedNullArgumentException
- activityUnitForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllActivityUnits() throws OperationFailedException, PermissionDeniedException
ActivityUnits
in this CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivityUnits(IdList activityUnitIds) throws OperationFailedException, PermissionDeniedException
Ids.
activityUnitIds
- the Ids
of the activity units
to deleteNullArgumentException
- activityUnitIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivityUnitsForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
courseId
- an Id
of a courseNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasActivityUnits(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.