org.osid.installation.batch

Interface PackageBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPackages(AliasRequestList aliasRequests) Adds an Id to a Package for the purpose of creating compatibility.
CreateResponseList	createPackages(PackageBatchFormList packageForms) Creates a new set of Packages.
DeleteResponseList	deleteAllPackages() Deletes all Packages in this Depot .
DeleteResponseList	deletePackages(IdList packageIds) Deletes packages for the given Ids.
PackageBatchFormList	getPackageFormsForCreate(long number, Type[] packageRecordTypes) Gets the package forms for creating a bunch of new packages.
PackageBatchFormList	getPackageFormsForUpdate(IdList packageIds) Gets the package forms for updating an existing set of packages.
UpdateResponseList	updatePackages(PackageBatchFormList packageForms) Updates existing packages.

Methods inherited from interface org.osid.installation.PackageAdminSession

addPackageVersion, aliasPackage, canCreateInstallationContent, canCreateInstallationContentWithRecordTypes, canCreatePackages, canCreatePackageWithRecordTypes, canDeleteInstallationContents, canDeletePackage, canDeletePackages, canManagePackageAliases, canManagePackageVersions, canUpdateInstallationContents, canUpdatePackage, canUpdatePackages, createInstallationContent, createPackage, deleteInstallationContent, deletePackage, getDepot, getDepotId, getInstallationContentFormForCreate, getInstallationContentFormForUpdate, getPackageFormForCreate, getPackageFormForUpdate, removePackageVersion, updateInstallationContent, updatePackage

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

getPackageFormsForCreate

PackageBatchFormList getPackageFormsForCreate(long number,
                                            Type[] packageRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the package forms for creating a bunch of new packages.

Parameters:

number - the number of forms to retrieve

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

Returns:

the package forms

Throws:

NullArgumentException - packageRecordTypes 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.

createPackages

CreateResponseList createPackages(PackageBatchFormList packageForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

packageForms - the package forms

Returns:

the create responses

Throws:

NullArgumentException - packageForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPackageFormsForUpdate

PackageBatchFormList getPackageFormsForUpdate(IdList packageIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

packageIds - the Ids of the Package

Returns:

the package form

Throws:

NotFoundException - a packageId is not found

NullArgumentException - packageIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePackages

UpdateResponseList updatePackages(PackageBatchFormList packageForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

packageForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - packageForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPackages

DeleteResponseList deleteAllPackages()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Packages in this Depot .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePackages

DeleteResponseList deletePackages(IdList packageIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes packages for the given Ids.

Parameters:

packageIds - the Ids of the packages to delete

Returns:

the delete responses

Throws:

NullArgumentException - packageIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPackages

AliasResponseList aliasPackages(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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