Interface | osid.course.registration.batch.ActivityRegistrationBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.registration.ActivityRegistrationAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getActivityRegistrationFormsForCreate | ||
Description |
Gets the activity registration forms for creating a bunch of new activity registrations. A form is returned for each activity and resource pair. | ||
Parameters | osid.course.registration.batch.ActivityRegistrationPeerList | peers | the relationship peers |
osid.type.Type[] | activityRegistrationRecordTypes | array of activity registration record types to be included in each create operation or an empty list if none | |
Return | osid.course.registration.batch.ActivityRegistrationBatchFormList | the activity registration forms | |
Errors | NOT_FOUND | a registrationId or resourceId is not found | |
NULL_ARGUMENT | peers or activityRegistrationRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createActivityRegistrations | ||
Description |
Creates a new set of | ||
Parameters | osid.course.registration.batch.ActivityRegistrationBatchFormList | activityRegistrationForms | the activity registration forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | activityRegistrationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationFormsForUpdate | ||
Description |
Gets the activity registration forms for updating an existing set of activity registrations. A new activity registration form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | activityRegistrationIds | the Ids of the ActivityRegistration |
Return | osid.course.registration.batch.ActivityRegistrationBatchFormList | the activity registration form | |
Errors | NOT_FOUND | an activityRegistrationId is not found | |
NULL_ARGUMENT | activityRegistrationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateActivityRegistrations | ||
Description |
Updates existing activity registrations. This method
returns an error if the entire operation fails. Otherwise,
the status of an individual update operation is indicated
in the | ||
Parameters | osid.course.registration.batch.ActivityRegistrationBatchFormList | activityRegistrationForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | activityRegistrationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllActivityRegistrations | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteActivityRegistrations | ||
Description |
Deletes activity registrations for the given | ||
Parameters | osid.id.IdList | activityRegistrationIds | the Ids of the activity registrations to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | activityRegistrationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteActivityRegistrationsForRegistration | ||
Description |
Deletes activity registrations for the given registration. | ||
Parameters | osid.id.Id | registrationId | an Id of a registration |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteActivityRegistrationsForActivity | ||
Description |
Deletes activity registrations for the given activity. | ||
Parameters | osid.id.Id | activityId | an Id of an activity |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteActivityRegistrationsForStudent | ||
Description |
Deletes activity registrations for the given student resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveActivityRegistrationsByDate | ||
Description |
Deletes activity registrations expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasActivityRegistrations | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |