public interface ActivityRegistrationBatchAdminSession extends ActivityRegistrationAdminSession
This session creates, updates, and deletes ActivityRegistrations
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
ActivityRegistration,
an ActivityRegistrationForm
is requested using getActivityRegistrationFormsForCreate()
specifying the desired registration, activity, student, and record
Types
or none if no record Types
are needed.
Each of the returned ActivityRegistrationForms
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
ActivityRegistrationForm
is submiited to a create operation, it
cannot be reused with another create operation unless the first operation
was unsuccessful. Each ActivityRegistrationForm
corresponds
to an attempted transaction.
The ActivityRegistrationForms
returned from
getActivityRegistrationFormsForCreate()
may be linked to the
originating request through the peer Ids
of the
ActivityRegistrationForm.
In the case where there may be
duplicates, any ActivityRegistrationForm
of the same peer
Ids
may be used for a create operation.
Once a batch of ActivityRegistrationForms
are submitted
for create, a CreateResponse
is returned for each
ActivityRegistrationForm,
although the ordering is not defined.
Only errors that pertain to the entire create operation are returned from
createActivityRegistrations(),
errors specific to an
individual ActivityRegistrationForm
are indicated in the
corresponding CreateResponse.
CreateResponses
may be linked to the originating ActivityRegistrationForm
through the ActivityRegistrationForm
Id
.
For updates, ActivityRegistrationForms
are requested to
the ActivityRegistration
Id
that is to be
updated using getActivityRegistrationFormsForUpdate()
where
the reference Id
in the ActivityRegistrationForm
may be used to link the request. Similarly, the
ActivityRegistrationForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
ActivityRegistrationForm
can only be used once for a
successful update and cannot be reused.
Once a batch of ActivityRegistrationForms
are submitted
for update, an UpdateResponse
is returned for each
ActivityRegistrationForm,
although the ordering is not defined.
Only errors that pertain to the entire update operation are returned from
updateActivityRegistrations(),
errors specific to an
individual ActivityRegistrationForm
are indicated in the
corresponding UpdateResponse.
UpdateResponses
may be linked to the originating ActivityRegistrationForm
through the ActivityRegistrationForm
Id.
The delete operations delete ActivityRegistrations
in
bulk. To unmap an ActivityRegistration
from the current
CourseCatalog,
the
ActivityRegistrationCourseCatalogAssignmentSession
should be used.
These delete operations attempt to remove the ActivityRegistration
itself thus removing it from all known CourseCatalog
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasActivityRegistrations(AliasRequestList aliasRequests)
Adds an
Id to an ActivityRegistration
for the purpose of creating compatibility. |
CreateResponseList |
createActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms)
Creates a new set of
ActivityRegistrations. |
DeleteResponseList |
deleteActivityRegistrations(IdList activityRegistrationIds)
Deletes activity registrations for the given
Ids. |
DeleteResponseList |
deleteActivityRegistrationsForActivity(Id activityId)
Deletes activity registrations for the given activity.
|
DeleteResponseList |
deleteActivityRegistrationsForRegistration(Id registrationId)
Deletes activity registrations for the given registration.
|
DeleteResponseList |
deleteActivityRegistrationsForStudent(Id resourceId)
Deletes activity registrations for the given student resource.
|
DeleteResponseList |
deleteAllActivityRegistrations()
Deletes all
ActivityRegistrations in this
CourseCatalog . |
DeleteResponseList |
deleteIneffectiveActivityRegistrationsByDate(DateTime date)
Deletes activity registrations expired before the given date.
|
ActivityRegistrationBatchFormList |
getActivityRegistrationFormsForCreate(ActivityRegistrationPeerList peers,
Type[] activityRegistrationRecordTypes)
Gets the activity registration forms for creating a bunch of new
activity registrations.
|
ActivityRegistrationBatchFormList |
getActivityRegistrationFormsForUpdate(IdList activityRegistrationIds)
Gets the activity registration forms for updating an existing set of
activity registrations.
|
UpdateResponseList |
updateActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms)
Updates existing activity registrations.
|
aliasActivityRegistration, canCreateActivityRegistrations, canCreateActivityRegistrationWithRecordTypes, canDeleteActivityRegistrations, canManageActivityRegistrationAliases, canUpdateActivityRegistrations, createActivityRegistration, deleteActivityRegistration, getActivityRegistrationFormForCreate, getActivityRegistrationFormForUpdate, getCourseCatalog, getCourseCatalogId, updateActivityRegistration
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActivityRegistrationBatchFormList getActivityRegistrationFormsForCreate(ActivityRegistrationPeerList peers, Type[] activityRegistrationRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersactivityRegistrationRecordTypes
- array of activity registration
record types to be included in each create operation or an
empty list if noneNotFoundException
- a registrationId
or
resourceId
is not foundNullArgumentException
- peers
or
activityRegistrationRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.activityRegistrationForms
- the activity registration formsNullArgumentException
-
activityRegistrationForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationBatchFormList getActivityRegistrationFormsForUpdate(IdList activityRegistrationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityRegistrationIds
- the Ids
of the
ActivityRegistration
NotFoundException
- an activityRegistrationId
is not foundNullArgumentException
- activityRegistrationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateActivityRegistrations(ActivityRegistrationBatchFormList activityRegistrationForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.activityRegistrationForms
- the form containing the elements to
be updatedNullArgumentException
-
activityRegistrationForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllActivityRegistrations() throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
in this
CourseCatalog
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivityRegistrations(IdList activityRegistrationIds) throws OperationFailedException, PermissionDeniedException
Ids.
activityRegistrationIds
- the Ids
of the activity
registrations to deleteNullArgumentException
- activityRegistrationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivityRegistrationsForRegistration(Id registrationId) throws OperationFailedException, PermissionDeniedException
registrationId
- an Id
of a registrationNullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivityRegistrationsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
activityId
- an Id
of an activityNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActivityRegistrationsForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- an Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveActivityRegistrationsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasActivityRegistrations(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an ActivityRegistration
for the purpose of creating compatibility. The primary Id
of the ActivityRegistration
is determined by
the provider. The new Id
is an alias to the primary
Id.
If the alias is a pointer to another activity
registration, it is reassigned to the given activity registration
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.