OSID Logo
OSID Specifications
inventory batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.batch.ModelBatchAdminSession
Implementsosid.inventory.ModelAdminSession
Description

This session creates, updates, and deletes Models 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 Model, a ModelForm is requested using getModelFormsForCreate() specifying the desired stock, resource, record Types or none if no record Types are needed. Each of the returned ModelForms 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 ModelForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ModelForm corresponds to an attempted transaction.

The ModelForms returned from getModelFormsForCreate() may be linked to the originating request through the peer Ids of the ModelForm. In the case where there may be duplicates, any ModelForm of the same peer Ids may be used for a create operation.

Once a batch of ModelForms are submitted for create, a CreateResponse is returned for each ModelForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createModels(), errors specific to an individual ModelForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ModelForm through the ModelForm Id .

For updates, ModelForms are requested to the Model Id that is to be updated using getModelFormsForUpdate() where the reference Id in the ModelForm may be used to link the request. Similarly, the ModelForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ModelForm can only be used once for a successful update and cannot be reused.

Once a batch of ModelForms are submitted for update, an UpdateResponse is returned for each ModelForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateModels(), errors specific to an individual ModelForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ModelForm through the ModelForm Id.

The delete operations delete Models in bulk. To unmap a Model from the current Inventory, the ModelInventoryAssignmentSession should be used. These delete operations attempt to remove the Model itself thus removing it from all known Inventory catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetModelFormsForCreate
Description

Gets the model forms for creating a bunch of new models.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]modelRecordTypesarray of model record types to be included in each create operation or an empty list if none
Returnosid.inventory.batch.ModelBatchFormListthe model forms
ErrorsNULL_ARGUMENT modelRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateModels
Description

Creates a new set of Models. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.inventory.batch.ModelBatchFormListmodelFormsthe model forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT modelForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetModelFormsForUpdate
Description

Gets the model forms for updating an existing set of models. A new model form should be requested for each update transaction.

Parametersosid.id.IdListmodelIdsthe Ids of the Model
Returnosid.inventory.batch.ModelBatchFormListthe model form
ErrorsNOT_FOUNDa modelId is not found
NULL_ARGUMENT modelIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateModels
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 BatchCreateResponse .

Parametersosid.inventory.batch.ModelBatchFormListmodelFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT modelForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllModels
Description

Deletes all Models in this Inventory .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteModels
Description

Deletes models for the given Ids.

Parametersosid.id.IdListmodelIdsthe Ids of the models to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT modelIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteModelsForResource
Description

Deletes models for the given resource.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteModelsForStock
Description

Deletes models for the given stock.

Parametersosid.id.IdstockIdan Id of a stock
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT stockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveModelsByDate
Description

Deletes models expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasModels
Description

Adds an Id to a Model for the purpose of creating compatibility. The primary Id of the Model is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another model, it is reassigned to the given model Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.