Interface | osid.installation.PackageDepotAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
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
| ||
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
| ||
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 | |
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 |
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 | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPackageToDepot | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | packageId | the Id of the Package |
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 | ||
Parameters | osid.id.Id | packageId | the Id of the Package |
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. |