Interface | osid.installation.PackageLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Packages may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getDepotId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Depot Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDepot | ||
Description |
Gets the | ||
Return | osid.installation.Depot | the Depot associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupPackages | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativePackageView | ||
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 | usePlenaryPackageView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedDepotView | ||
Description |
Federates the view for methods in this session. A federated view will include packages in depots which are children of this depot in the depot hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedDepotView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this depot only. | ||
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 | getPackage | ||
Description |
Gets the | ||
Parameters | osid.id.Id | packageId | Id of the Package |
Return | osid.installation.Package | the package | |
Errors | NOT_FOUND | packageId not found | |
NULL_ARGUMENT | packageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPackagesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | packageIds | the list of Ids to retrieve |
Return | osid.installation.PackageList | the returned Package list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | packageIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackagesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | packageGenusType | a package genus type |
Return | osid.installation.PackageList | the returned Package list | |
Errors | NULL_ARGUMENT | packageGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackagesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | packageGenusType | a package genus type |
Return | osid.installation.PackageList | the returned Package list | |
Errors | NULL_ARGUMENT | packageGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackagesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | packageRecordType | a package record type |
Return | osid.installation.PackageList | the returned Package list | |
Errors | NULL_ARGUMENT | packageRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPackagesByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.installation.PackageList | the returned Package list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDependentPackages | ||
Description |
Gets a list of packages depending on the given package. | ||
Parameters | osid.id.Id | packageId | an Id of a Package |
Return | osid.installation.PackageList | list of package dependents | |
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 | getPackageVersions | ||
Description |
Gets a list of packages in the specified package version chain. | ||
Parameters | osid.id.Id | packageId | an Id of a Package |
Return | osid.installation.PackageList | list of dependencies | |
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 | getPackages | ||
Description |
Gets all | ||
Return | osid.installation.PackageList | a PackageList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |