org.osid.repository.batch

Interface AssetBatchAdminSession

All Superinterfaces:

AssetAdminSession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AssetBatchAdminSession
extends AssetAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAssets(AliasRequestList aliasRequests) Adds an Id to an Asset for the purpose of creating compatibility.
CreateResponseList	createAssets(AssetBatchFormList assetForms) Creates a new set of Assets.
DeleteResponseList	deleteAllAssetContents() Deletes all AssetContents in this Repository .
DeleteResponseList	deleteAllAssets() Deletes all Assets in this Repository .
DeleteResponseList	deleteAssetContents(IdList assetContentIds) Deletes asset contents for the given Ids.
DeleteResponseList	deleteAssetContentsForAsset(Id assetId) Deletes asset contents for the given asset.
DeleteResponseList	deleteAssets(IdList assetIds) Deletes assets for the given Ids.
AssetBatchFormList	getAssetFormsForCreate(long number, Type[] assetRecordTypes) Gets the asset forms for creating a bunch of new assets.
AssetBatchFormList	getAssetFormsForUpdate(IdList assetIds) Gets the asset forms for updating an existing set of assets.
UpdateResponseList	updateAssets(AssetBatchFormList assetForms) Updates existing assets.

Methods inherited from interface org.osid.repository.AssetAdminSession

aliasAsset, canCreateAssetContent, canCreateAssetContentWithRecordTypes, canCreateAssets, canCreateAssetWithRecordTypes, canDeleteAssetContents, canDeleteAssets, canManageAssetAliases, canUpdateAssetContents, canUpdateAssets, createAsset, createAssetContent, deleteAsset, deleteAssetContent, getAssetContentFormForCreate, getAssetContentFormForUpdate, getAssetFormForCreate, getAssetFormForUpdate, getRepository, getRepositoryId, updateAsset, updateAssetContent

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAssetFormsForCreate

AssetBatchFormList getAssetFormsForCreate(long number,
                                        Type[] assetRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

assetRecordTypes - array of asset record types to be included in each create operation or an empty list if none

Returns:

the asset forms

Throws:

NullArgumentException - assetRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createAssets

CreateResponseList createAssets(AssetBatchFormList assetForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

assetForms - the asset forms

Returns:

the create responses

Throws:

NullArgumentException - assetForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssetFormsForUpdate

AssetBatchFormList getAssetFormsForUpdate(IdList assetIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

assetIds - the Ids of the Asset

Returns:

the asset form

Throws:

NotFoundException - an assetId is not found

NullArgumentException - assetIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAssets

UpdateResponseList updateAssets(AssetBatchFormList assetForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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 .

Parameters:

assetForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - assetForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAssets

DeleteResponseList deleteAllAssets()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Assets in this Repository .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAssets

DeleteResponseList deleteAssets(IdList assetIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes assets for the given Ids.

Parameters:

assetIds - the Ids of the assets to delete

Returns:

the delete responses

Throws:

NullArgumentException - assetIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAssets

AliasResponseList aliasAssets(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAssetContents

DeleteResponseList deleteAllAssetContents()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all AssetContents in this Repository .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAssetContents

DeleteResponseList deleteAssetContents(IdList assetContentIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes asset contents for the given Ids.

Parameters:

assetContentIds - the Ids of the asset contents to delete

Returns:

the delete responses

Throws:

NullArgumentException - assetContentsIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAssetContentsForAsset

DeleteResponseList deleteAssetContentsForAsset(Id assetId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes asset contents for the given asset.

Parameters:

assetId - an Id of the asset

Returns:

the delete responses

Throws:

NullArgumentException - assetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.