| Interface | osid.offering.batch.ParticipantBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.offering.ParticipantAdminSession | ||
| 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 | getParticipantFormsForCreate | ||
| Description | 
                     Gets the participant forms for creating a bunch of new participants. A form is returned for each canonical canonical unit and term pair.  | ||
| Parameters | osid.offering.batch.ParticipantPeerList | peers | the relationship peers | 
osid.type.Type[] | participantRecordTypes | array of participant record types to be included in each create operation or an empty list if none | |
| Return | osid.offering.batch.ParticipantBatchFormList | the participant forms | |
| Errors | NOT_FOUND | an  offeringId  or  resourceId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  participantRecordTypes  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 | createParticipants | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.offering.batch.ParticipantBatchFormList | participantForms | the participant forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  participantForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getParticipantFormsForUpdate | ||
| Description | 
                     Gets the participant forms for updating an existing set of participants. A new participant form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | participantIds | the  Ids  of the  Participant   | 
| Return | osid.offering.batch.ParticipantBatchFormList | the participant form | |
| Errors | NOT_FOUND | a  participantId  is not found  |                 |
| NULL_ARGUMENT |  participantIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateParticipants | ||
| Description | 
                     Updates existing participants. This method returns an 
                    error if the entire operation fails. Otherwise, the status 
                    of an individual update operation is indicated in the 
                      | ||
| Parameters | osid.offering.batch.ParticipantBatchFormList | participantForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  participantForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllParticipants | ||
| 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 | deleteParticipants | ||
| Description | 
                     Deletes participants for the given   | ||
| Parameters | osid.id.IdList | participantIds | the  Ids  of the participants to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  participantIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteParticipantsForOffering | ||
| Description | 
                     Deletes participants for the given offering.  | ||
| Parameters | osid.id.Id | offeringId | the  Id  of an offering  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  offeringId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteParticipantsForResource | ||
| Description | 
                     Deletes participants for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | the  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 | aliasParticipants | ||
| 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. | |