Interface | osid.installation.PackageDepotSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines two views:
| ||
Method | canLookupPackageDepotMappings | ||
Description |
Tests if this user can perform lookups of package/depot
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known lookup methods in this session will result in a
| ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDepotView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryDepotView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useNormalizedVersionView | ||
Description |
The returns from the lookup methods may omit multiple versions of the same package. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useDenormalizedVersionView | ||
Description |
All versions of the same package are returned. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useNormalizedDependencyView | ||
Description |
A normalized view uses a single | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useDenormalizedDependencyView | ||
Description |
A denormalized view returns all dependencies. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPackageIdsByDepot | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | depotId | Id of the Depot |
Return | osid.id.IdList | list of related package Ids | |
Errors | NOT_FOUND | depotId is not found | |
NULL_ARGUMENT | depotId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackagesByDepot | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | depotId | Id of the Depot |
Return | osid.installation.PackageList | list of related packages | |
Errors | NOT_FOUND | depotId is not found | |
NULL_ARGUMENT | depotId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackageIdsByDepots | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | depotIds | list of depot Ids |
Return | osid.id.IdList | list of package Ids | |
Errors | NULL_ARGUMENT | depotIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackagesByDepots | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | depotIds | list of depot Ids |
Return | osid.installation.PackageList | list of packages | |
Errors | NULL_ARGUMENT | depotIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDepotIdsByPackage | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | packageId | Id of a Package |
Return | osid.id.IdList | list of depot Ids | |
Errors | NOT_FOUND | packageId is not found | |
NULL_ARGUMENT | packageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDepotsByPackage | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | packageId | Id of a Package |
Return | osid.installation.DepotList | list of depots | |
Errors | NOT_FOUND | packageId is not found | |
NULL_ARGUMENT | packageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |