Interface PackageBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PackageAdminSession
public interface PackageBatchAdminSession extends PackageAdminSession

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

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

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

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

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

The delete operations delete Packages in bulk. To unmap a Package from the current Depot , the PackageDepotAssignmentSession should be used. These delete operations attempt to remove the Package itself thus removing it from all known Depot catalogs. Bulk delete operations return the results in DeleteResponses .