OSID Logo
OSID Specifications
installation batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.batch.PackageBatchAdminSession
Implementsosid.installation.PackageAdminSession
Description

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.

MethodgetPackageFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]packageRecordTypesarray of package record types to be included in each create operation or an empty list if none
Returnosid.installation.batch.PackageBatchFormListthe package forms
ErrorsNULL_ARGUMENT packageRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreatePackages
Description

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 .

Parametersosid.installation.batch.PackageBatchFormListpackageFormsthe package forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT packageForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackageFormsForUpdate
Description

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

Parametersosid.id.IdListpackageIdsthe Ids of the Package
Returnosid.installation.batch.PackageBatchFormListthe package form
ErrorsNOT_FOUNDa packageId is not found
NULL_ARGUMENT packageIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePackages
Description

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 .

Parametersosid.installation.batch.PackageBatchFormListpackageFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT packageForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPackages
Description

Deletes all Packages in this Depot .

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

Deletes packages for the given Ids.

Parametersosid.id.IdListpackageIdsthe Ids of the packages to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT packageIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPackages
Description

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.

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.