| Interface | osid.course.syllabus.batch.DocetBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.syllabus.DocetAdminSession | ||
| 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 | getDocetFormsForCreate | ||
| Description | 
                     Gets the docet forms for creating a bunch of new docets. A form is returned for each activity and resource pair.  | ||
| Parameters | osid.course.syllabus.batch.DocetPeerList | peers | the relationship peers | 
osid.type.Type[] | docetRecordTypes | array of docet record types to be included in each create operation or an empty list if none | |
| Return | osid.course.syllabus.batch.DocetBatchFormList | the docet forms | |
| Errors | NOT_FOUND | a  moduleId  or  activityUnitId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  docetRecordTypes  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 | createDocets | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.course.syllabus.batch.DocetBatchFormList | docetForms | the docet forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  docetForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetFormsForUpdate | ||
| Description | 
                     Gets the docet forms for updating an existing set of docets. A new docet form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | docetIds | the  Ids  of the  Docet   | 
| Return | osid.course.syllabus.batch.DocetBatchFormList | the docet form | |
| Errors | NOT_FOUND | an  docetId  is not found  |                 |
| NULL_ARGUMENT |  docetIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateDocets | ||
| Description | 
                     Updates existing docets. 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.syllabus.batch.DocetBatchFormList | docetForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  docetForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllDocets | ||
| 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 | deleteDocets | ||
| Description | 
                     Deletes docets for the given   | ||
| Parameters | osid.id.IdList | docetIds | the  Ids  of the docets to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  docetIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteDocetsForModule | ||
| Description | 
                     Deletes docets for the given module.  | ||
| Parameters | osid.id.Id | moduleId | an  Id  of a module  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  moduleId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteDocetsForActivityUnit | ||
| Description | 
                     Deletes docets for the given activity unit.  | ||
| Parameters | osid.id.Id | activityUnitId | an  Id  of a resource  | 
| 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 | deleteIneffectiveDocetsByDate | ||
| Description | 
                     Deletes docets 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 | aliasDocets | ||
| 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. | |