| Interface | osid.offering.batch.OfferingBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.offering.OfferingAdminSession | ||
| 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 | getOfferingFormsForCreate | ||
| Description | 
                     Gets the offeringforms for creating a bunch of new offerings. A new result form is returned for each supplied canonical unit and time period.  | ||
| Parameters | osid.offering.batch.OfferingPeerList | peers | a list of canonical unit peers | 
osid.type.Type[] | offeringRecordTypes | array of offering record types to be included in each create operation or an empty list if none | |
| Return | osid.offering.batch.OfferingBatchFormList | the offeringforms | |
| Errors | NOT_FOUND | a  canonicalUnitId  or  timePeriodId  is not 
found  |                 |
| NULL_ARGUMENT |  peers  or  offeringRecordTypes  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 | createOfferings | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.offering.batch.OfferingBatchFormList | offeringForms | the offering forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  offeringForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingFormsForUpdate | ||
| Description | 
                     Gets the offering forms for updating an existing set of offerings. A new offeringform should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | offeringIds | the  Ids  of the  Offering   | 
| Return | osid.offering.batch.OfferingBatchFormList | the offering form | |
| Errors | NOT_FOUND | an  offeringId  is not found  |                 |
| NULL_ARGUMENT |  offeringIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateOfferings | ||
| Description | 
                     Updates existing offerings. 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.OfferingBatchFormList | offeringForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  offeringForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllOfferings | ||
| 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 | deleteOfferings | ||
| Description | 
                     Deletes offerings for the given   | ||
| Parameters | osid.id.IdList | offeringIds | the  Ids  of the offerings to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  offeringIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteOfferingsForCanonicalUnit | ||
| Description | 
                     Deletes all offerings mapped to the given canonical unit.  | ||
| Parameters | osid.id.Id | canonicalUnitId | an  Id  of a canonical unit  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  canonicalUnitId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteOfferingsForTimePeriod | ||
| Description | 
                     Deletes all offerings mapped to the given time period.  | ||
| Parameters | osid.id.Id | timePeriodId | an  Id  of a time period  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  timePeriodId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasOfferings | ||
| 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. | |