OSID - osid.installation.PackageDepotAssignmentSession Service Interface Definition

Interface	osid.installation.PackageDepotAssignmentSession
Implements	`osid.OsidSession`
Description	This session provides methods to re-assign `Packages` to `Depots` . A `Package` may map to multiple `Depots` and removing the last reference to an `Package` 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 `Package` to another `Depot` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignPackages
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.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignPackagesToDepot
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.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`depotId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableDepotIds
Description	Gets a list of depot including and under the given depot node in which any package can be assigned.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot`
Return	`osid.id.IdList`		list of assignable depot `Ids`
Errors	NULL_ARGUMENT		`depotId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableDepotIdsForPackage
Description	Gets a list of depot including and under the given depot node in which a specific package can be assigned.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot`
Parameters	`osid.id.Id`	`packageId`	the `Id` of the `Package`
Return	`osid.id.IdList`		list of assignable depot `Ids`
Errors	NULL_ARGUMENT		`depotId` or `packageId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignPackageToDepot
Description	Adds an existing `Package` to a `Depot` .
Parameters	`osid.id.Id`	`packageId`	the `Id` of the `Package`
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot`
Errors	ALREADY_EXISTS		`packageId` is already assigned to `depotId`
	NOT_FOUND		`packageId` or `depotId` not found
	NULL_ARGUMENT		`packageId` or `depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPackageFromDepot
Description	Removes a `Package` from a `Depot` .
Parameters	`osid.id.Id`	`packageId`	the `Id` of the `Package`
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot`
Errors	NOT_FOUND		`packageId` or `depotId` not found or `packageId` not assigned to `depotId`
	NULL_ARGUMENT		`packageId` or `depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignPackageToDepot
Description	Moves a `Package` from one `Depot` to another. Mappings to other `Depots` are unaffected.
Parameters	`osid.id.Id`	`packageId`	the `Id` of the `Package`
	`osid.id.Id`	`fromDepotId`	the `Id` of the current `Depot`
	`osid.id.Id`	`toDepotId`	the `Id` of the destination `Depot`
Errors	ALREADY_EXISTS		`packageId` already assigned to `toDepotId`
	NOT_FOUND		`packageId, fromDepotId` , or `toDepotId` not found or `packageId` not mapped to `fromDepotId`
	NULL_ARGUMENT		`packageId, fromDepotId` , or `toDepotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.