| Interface | osid.ontology.batch.SubjectBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.ontology.SubjectAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getSubjectFormsForCreate | ||
| Description | 
                     Gets the subject forms for creating a bunch of new subjects.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | subjectRecordTypes | array of subject record types to be included in each create operation or an empty list if none | |
| Return | osid.ontology.batch.SubjectBatchFormList | the subject forms | |
| Errors | NULL_ARGUMENT |  subjectRecordTypes  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 | createSubjects | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.ontology.batch.SubjectBatchFormList | subjectForms | the subject forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  subjectForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectFormsForUpdate | ||
| Description | 
                     Gets the subject forms for updating an existing set of subjects. A new subject form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | subjectIds | the  Ids  of the  Subject   | 
| Return | osid.ontology.batch.SubjectBatchFormList | the subject form | |
| Errors | NOT_FOUND | a  subjectId  is not found  |                 |
| NULL_ARGUMENT |  subjectIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateSubjects | ||
| Description | 
                     Updates existing subjects. This method returns an error 
                    if the entire operation fails. Otherwise, the status of an 
                    individual update operation is indicated in the   | ||
| Parameters | osid.ontology.batch.SubjectBatchFormList | subjectForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  subjectForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllSubjects | ||
| 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 | deleteSubjects | ||
| Description | 
                     Deletes subjects for the given   | ||
| Parameters | osid.id.IdList | subjectIds | the  Ids  of the subjects to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  subjectIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasSubjects | ||
| 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. | |