OSID Logo
OSID Specifications
repository batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.batch.AssetBatchAdminSession
Implementsosid.repository.AssetAdminSession
Description

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

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

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

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

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

The delete operations delete Assets in bulk. To unmap an Asset from the current Repository, the AssetRepositoryAssignmentSession should be used. These delete operations attempt to remove the Asset itself thus removing it from all known Repository catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetAssetFormsForCreate
Description

Gets the asset forms for creating a bunch of new assets.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]assetRecordTypesarray of asset record types to be included in each create operation or an empty list if none
Returnosid.repository.batch.AssetBatchFormListthe asset forms
ErrorsNULL_ARGUMENT assetRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAssets
Description

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

Parametersosid.repository.batch.AssetBatchFormListassetFormsthe asset forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT assetForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetFormsForUpdate
Description

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

Parametersosid.id.IdListassetIdsthe Ids of the Asset
Returnosid.repository.batch.AssetBatchFormListthe asset form
ErrorsNOT_FOUNDan assetId is not found
NULL_ARGUMENT assetIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAssets
Description

Updates existing assets. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.repository.batch.AssetBatchFormListassetFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT assetForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAssets
Description

Deletes all Assets in this Repository .

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

Deletes assets for the given Ids.

Parametersosid.id.IdListassetIdsthe Ids of the assets to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assetIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAssets
Description

Adds an Id to an Asset for the purpose of creating compatibility. The primary Id of the Asset is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another asset, it is reassigned to the given asset 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.
MethoddeleteAllAssetContents
Description

Deletes all AssetContents in this Repository .

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

Deletes asset contents for the given Ids.

Parametersosid.id.IdListassetContentIdsthe Ids of the asset contents to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assetContentsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssetContentsForAsset
Description

Deletes asset contents for the given asset.

Parametersosid.id.IdassetIdan Id of the asset
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT assetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.