OSID Logo
OSID Specifications
installation package
Version 3.1.0
Interfaceosid.installation.InstallationPackageDepotAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign InstallationPackages to Depots. A InstallationPackage may map to multiple Depots and removing the last reference to an InstallationPackage is the equivalent of deleting it. Each Depot may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a InstallationPackage to another Depot is not a copy operation (eg: does not change its Id).

MethodcanAssignInstallationPackages
Description

Tests if this user can alter package/depot mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignInstallationPackagesToDepot
Description

Tests if this user can alter package/depot mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IddepotId the Id of the Depot
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT depotId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableDepotIds
Description

Gets a list of depot including and under the given depot node in which any package can be assigned.

Parametersosid.id.IddepotId the Id of the Depot
Returnosid.id.IdList list of assignable depot Ids
ErrorsNULL_ARGUMENT depotId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableDepotIdsForInstallationPackage
Description

Gets a list of depot including and under the given depot node in which a specific package can be assigned.

Parametersosid.id.IddepotId the Id of the Depot
osid.id.IdinstallationPackageId the Id of the InstallationPackage
Returnosid.id.IdList list of assignable depot Ids
ErrorsNULL_ARGUMENT depotId or installationPackageId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignInstallationPackageToDepot
Description

Adds an existing InstallationPackage to a Depot.

Parametersosid.id.IdinstallationPackageId the Id of the InstallationPackage
osid.id.IddepotId the Id of the Depot
ErrorsALREADY_EXISTS installationPackageId is already assigned to depotId
NOT_FOUND installationPackageId or depotId not found
NULL_ARGUMENT installationPackageId or depotId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignInstallationPackageFromDepot
Description

Removes a InstallationPackage from a Depot.

Parametersosid.id.IdinstallationPackageId the Id of the InstallationPackage
osid.id.IddepotId the Id of the Depot
ErrorsNOT_FOUND installationPackageId or depotId not found or installationPackageId not assigned to depotId
NULL_ARGUMENT installationPackageId or depotId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignInstallationPackageToDepot
Description

Moves a InstallationPackage from one Depot to another. Mappings to other Depots are unaffected.

Parametersosid.id.IdinstallationPackageId the Id of the InstallationPackage
osid.id.IdfromDepotId the Id of the current Depot
osid.id.IdtoDepotId the Id of the destination Depot
ErrorsALREADY_EXISTS installationPackageId already assigned to toDepotId
NOT_FOUND installationPackageId, fromDepotId, or toDepotId not found or installationPackageId not mapped to fromDepotId
NULL_ARGUMENT installationPackageId, fromDepotId, or toDepotId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.