| Interface | osid.inventory.batch.ModelBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.inventory.ModelAdminSession | ||
| 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 | getModelFormsForCreate | ||
| Description | 
                     Gets the model forms for creating a bunch of new models.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | modelRecordTypes | array of model record types to be included in each create operation or an empty list if none | |
| Return | osid.inventory.batch.ModelBatchFormList | the model forms | |
| Errors | NULL_ARGUMENT |  modelRecordTypes  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 | createModels | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.inventory.batch.ModelBatchFormList | modelForms | the model forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  modelForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getModelFormsForUpdate | ||
| Description | 
                     Gets the model forms for updating an existing set of models. A new model form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | modelIds | the  Ids  of the  Model   | 
| Return | osid.inventory.batch.ModelBatchFormList | the model form | |
| Errors | NOT_FOUND | a  modelId  is not found  |                 |
| NULL_ARGUMENT |  modelIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateModels | ||
| Description | 
                     Updates existing models. This method returns an error 
                    if the entire operation fails. Otherwise, the status of an 
                    individual update operation is indicated in the   | ||
| Parameters | osid.inventory.batch.ModelBatchFormList | modelForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  modelForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllModels | ||
| 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 | deleteModels | ||
| Description | 
                     Deletes models for the given   | ||
| Parameters | osid.id.IdList | modelIds | the  Ids  of the models to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  modelIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteModelsForResource | ||
| Description | 
                     Deletes models for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | an  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 | deleteModelsForStock | ||
| Description | 
                     Deletes models for the given stock.  | ||
| Parameters | osid.id.Id | stockId | an  Id  of a stock  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  stockId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveModelsByDate | ||
| Description | 
                     Deletes models 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 | aliasModels | ||
| 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. | |