Interface InstallationPackageBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, InstallationPackageAdminSession, OsidSession, OsidSession
public interface InstallationPackageBatchAdminSession extends InstallationPackageAdminSession

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

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

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

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

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

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