Interface | osid.course.syllabus.batch.SyllabusBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.syllabus.SyllabusAdminSession | ||
Description |
This session creates, updates, and deletes Syllabi 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 a Syllabus, a SyllabusForm is requested using getSyllabusFormsForCreate() specifying the desired course and record Types or none if no record Types are needed. Each of the returned SyllabusForms 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 a SyllabusForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each SyllabusForm corresponds to an attempted transaction. The SyllabusForms returned from getSyllabusFormsForCreate() may be linked to the originating request through the peer Ids of the SyllabusForm. In the case where there may be duplicates, any SyllabusForm of the same peer Ids may be used for a create operation. Once a batch of SyllabusForms are submitted for create, a CreateResponse is returned for each SyllabusForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createSyllabi(), errors specific to an individual SyllabusForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating SyllabusForm through the SyllabusForm Id. For updates, Once a batch of The delete operations delete | ||
Method | getSyllabusFormsForCreate | ||
Description |
Gets the syllabus forms for creating a bunch of new syllabi. A new form is returned for each supplied course. | ||
Parameters | osid.id.IdList | courseIds | a list of course Ids |
osid.type.Type[] | syllabusRecordTypes | array of syllabus record types to be included in each create operation or an empty list if none | |
Return | osid.course.syllabus.batch.SyllabusBatchFormList | the syllabus forms | |
Errors | NOT_FOUND | a courseId is not found | |
NULL_ARGUMENT | courseIds or syllabusRecordTypes 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 | createSyllabi | ||
Description |
Creates a new set of | ||
Parameters | osid.course.syllabus.batch.SyllabusBatchFormList | syllabusForms | the syllabus forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | syllabusForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabusFormsForUpdate | ||
Description |
Gets the syllabus forms for updating an existing set of syllabi. A new syllabus form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | syllabusIds | the Ids of the Syllabus |
Return | osid.course.syllabus.batch.SyllabusBatchFormList | the syllabus form | |
Errors | NOT_FOUND | a syllabusId is not found | |
NULL_ARGUMENT | syllabusIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSyllabi | ||
Description |
Updates existing syllabi. 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.SyllabusBatchFormList | syllabusForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | syllabusForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllSyllabi | ||
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 | deleteSyllabi | ||
Description |
Deletes syllabi for the given | ||
Parameters | osid.id.IdList | syllabusIds | the Ids of the syllabi to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | syllabusIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSyllabiForCourse | ||
Description |
Deletes syllabi for the given course. | ||
Parameters | osid.id.Id | courseId | a course Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | courseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasSyllabi | ||
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. |