public interface ActivityBatchAdminSession extends ActivityAdminSession
This session creates, updates, and deletes Activities
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
Activity,
an ActivityForm
is requested using
getActivityFormsForCreate()
specifying the desired
activity, courseoffering, term, record Types
or none if no
record Types
are needed. Each of the returned
ActivityForms
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 ActivityForm
is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each ActivityForm
corresponds to an attempted transaction.
The ActivityForms
returned from
getActivityFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ActivityForm.
In the case where there may be duplicates, any ActivityForm
of the same peer Ids
may be used for a create
operation.
Once a batch of ActivityForms
are submitted for create,
a CreateResponse
is returned for each ActivityForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createActivities(),
errors specific to an individual ActivityForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
ActivityForm
through the ActivityForm
Id
.
For updates, ActivityForms
are requested to the
Activity
Id
that is to be updated using
getActivityFormsForUpdate()
where the reference Id
in the ActivityForm
may be used to link the request.
Similarly, the ActivityForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The ActivityForm
can only be used once for a
successful update and cannot be reused.
Once a batch of ActivityForms
are submitted for update,
an UpdateResponse
is returned for each ActivityForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateActivities(),
errors specific to an individual ActivityForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ActivityForm
through the ActivityForm
Id.
The delete operations delete Activities
in bulk. To
unmap an Activity
from the current CourseCatalog,
the ActivityCourseCatalogAssignmentSession
should
be used. These delete operations attempt to remove the Activity
itself thus removing it from all known CourseCatalog
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasActivities(AliasRequestList aliasRequests)
Adds an
Id to an Activity for the
purpose of creating compatibility. |
CreateResponseList |
createActivities(ActivityBatchFormList activityForms)
Creates a new set of
Activities. |
DeleteResponseList |
deleteActivities(IdList activityIds)
Deletes activities for the given
Ids. |
DeleteResponseList |
deleteActivitiesForActivityUnit(Id activityUnitId)
Deletes activities for the given activity unit.
|
DeleteResponseList |
deleteActivitiesForActivityUnitAndTerm(Id activityUnitId,
Id termId)
Deletes activities related to the given activity unit and term
|
DeleteResponseList |
deleteActivitiesForCourseOffering(Id courseOfferingId)
Deletes activities related to the given course offering.
|
DeleteResponseList |
deleteActivitiesForTerm(Id termId)
Deletes activities for the given term.
|
DeleteResponseList |
deleteAllActivities()
Deletes all
Activities in this CourseCatalog
. |
DeleteResponseList |
deleteIneffectiveActivitiesByDate(DateTime date)
Deletes activities ineffective before the given date.
|
ActivityBatchFormList |
getActivityFormsForCreate(ActivityPeerList peers,
Type[] activityRecordTypes)
Gets the activity forms for creating a bunch of new activities.
|
ActivityBatchFormList |
getActivityFormsForUpdate(IdList activityIds)
Gets the activity forms for updating an existing set of activities.
|
UpdateResponseList |
updateActivities(ActivityBatchFormList activityForms)
Updates existing activities.
|
addBlackout, addMeetingTime, addSchedule, aliasActivity, canCreateActivities, canCreateActivityWithRecordTypes, canDeleteActivities, canManageActivityAliases, canScheduleActivities, canUpdateActivities, clearBlackout, clearMeetingTimes, createActivity, deleteActivity, getActivityFormForCreate, getActivityFormForUpdate, getCourseCatalog, getCourseCatalogId, removeSchedule, updateActivity
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActivityBatchFormList getActivityFormsForCreate(ActivityPeerList peers, Type[] activityRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersactivityRecordTypes
- array of activity record types to be
included in each create operation or an empty list if noneNotFoundException
- an activityUnitId, courseId,
or termId
is not foundNullArgumentException
- peers
or
activityRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createActivities(ActivityBatchFormList activityForms) throws OperationFailedException, PermissionDeniedException
Activities.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.activityForms
- the activity formsNullArgumentException
- activityForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityBatchFormList getActivityFormsForUpdate(IdList activityIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityIds
- the Ids
of the Activity
NotFoundException
- an activityId
is not
foundNullArgumentException
- activityIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateActivities(ActivityBatchFormList activityForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.activityForms
- the form containing the elements to be updatedNullArgumentException
- activityForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllActivities() throws OperationFailedException, PermissionDeniedException
Activities
in this CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivities(IdList activityIds) throws OperationFailedException, PermissionDeniedException
Ids.
activityIds
- the Ids
of the activities to deleteNullArgumentException
- activityIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivitiesForActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
activityUnitId
- an Id
of an activity unitNullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivitiesForActivityUnitAndTerm(Id activityUnitId, Id termId) throws OperationFailedException, PermissionDeniedException
activityUnitId
- an Id
of an activity unittermId
- an Id
of a termNullArgumentException
- activityUnitId
or termId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivitiesForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
termId
- an Id
of a termNullArgumentException
- termId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivitiesForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
courseOfferingId
- an Id
of a courseOfferingNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveActivitiesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasActivities(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Activity
for the
purpose of creating compatibility. The primary Id
of
the Activity
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another activity, it is reassigned to the given
activity Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.