| Interface | osid.course.batch.ActivityBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.ActivityAdminSession | ||
| 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 | getActivityFormsForCreate | ||
| Description |
Gets the activity forms for creating a bunch of new activities. A form is returned for each canonical activity unit and term pair. | ||
| Parameters | osid.course.batch.ActivityPeerList | peers | the relationship peers |
osid.type.Type[] | activityRecordTypes | array of activity record types to be included in each create operation or an empty list if none | |
| Return | osid.course.batch.ActivityBatchFormList | the activity forms | |
| Errors | NOT_FOUND | an activityUnitId, courseId, or termId is not
found | |
| NULL_ARGUMENT | peers or activityRecordTypes 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 | createActivities | ||
| Description |
Creates a new set of | ||
| Parameters | osid.course.batch.ActivityBatchFormList | activityForms | the activity forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | activityForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityFormsForUpdate | ||
| Description |
Gets the activity forms for updating an existing set of activities. A new activity form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | activityIds | the Ids of the Activity |
| Return | osid.course.batch.ActivityBatchFormList | the activity form | |
| Errors | NOT_FOUND | an activityId is not found | |
| NULL_ARGUMENT | activityIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateActivities | ||
| Description |
Updates existing activities. 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.batch.ActivityBatchFormList | activityForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | activityForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllActivities | ||
| 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 | deleteActivities | ||
| Description |
Deletes activities for the given | ||
| Parameters | osid.id.IdList | activityIds | the Ids of the activities to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | activityIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteActivitiesForActivityUnit | ||
| Description |
Deletes activities for the given activity unit. | ||
| Parameters | osid.id.Id | activityUnitId | an Id of an activity unit |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | activityUnitId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteActivitiesForActivityUnitAndTerm | ||
| Description |
Deletes activities related to the given activity unit and term | ||
| Parameters | osid.id.Id | activityUnitId | an Id of an activity unit |
osid.id.Id | termId | an Id of a term | |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | activityUnitId or termId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteActivitiesForTerm | ||
| Description |
Deletes activities for the given term. | ||
| Parameters | osid.id.Id | termId | an Id of a term |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | termId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteActivitiesForCourseOffering | ||
| Description |
Deletes activities related to the given course offering. | ||
| Parameters | osid.id.Id | courseOfferingId | an Id of a courseOffering |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | courseOfferingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveActivitiesByDate | ||
| Description |
Deletes activities ineffective 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 | aliasActivities | ||
| 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. | |