OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Depot objects. The Depot represents a collection of Packages.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Depots it can access, without breaking execution. However, an administrative application may require all Depot elements to be available.

Depots may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Depot.

MethodcanLookupDepots
Description

Tests if this user can perform Depot lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDepotView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDepotView
Description

A complete view of the Depot returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetDepot
Description

Gets the Depot specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Depot may have a different Id than requested, such as the case where a duplicate Id was assigned to a Depot and retained for compatility.

Parametersosid.id.IddepotId Id of the Depot
Returnosid.installation.Depotthe depot
ErrorsNOT_FOUND depotId not found
NULL_ARGUMENT depotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetDepotsByIds
Description

Gets a DepotList corresponding to the given IdList. In plenary mode, the returned list contains all of the depots specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Depot objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListdepotIdsthe list of Ids to retrieve
Returnosid.installation.DepotListthe returned Depot list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT depotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotsByGenusType
Description

Gets a DepotList corresponding to the given depot genus Type which does not include depots of types derived from the specified Type. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parametersosid.type.TypedepotGenusTypea depot genus type
Returnosid.installation.DepotListthe returned Depot list
ErrorsNULL_ARGUMENT depotGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotsByParentGenusType
Description

Gets a DepotList corresponding to the given depot genus Type and include any additional depots with genus types derived from the specified Type. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parametersosid.type.TypedepotGenusTypea depot genus type
Returnosid.installation.DepotListthe returned Depot list
ErrorsNULL_ARGUMENT depotGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotsByRecordType
Description

Gets a DepotList containing the given depot record Type. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parametersosid.type.TypedepotRecordTypea depot record type
Returnosid.installation.DepotListthe returned Depot list
ErrorsNULL_ARGUMENT depotRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotsByProvider
Description

Gets a DepotList for the given provider . In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.installation.DepotListthe returned Depot list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepots
Description

Gets all Depots. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Returnosid.installation.DepotLista DepotList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.