OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotSearchSession
Implementsosid.installation.DepotQuerySession
Description

This session provides methods for searching among Depot objects. The search query is constructed using the DepotQuery.

getDepotsByQuery() is the basic search method and returns a list of Depot objects.A more advanced search may be performed with getDepotsBySearch(). It accepts a DepotSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDepotsBySearch() returns a DepotSearchResults that can be used to access the resulting DepotList or be used to perform a search within the result set through DepotSearch.

Depots may have a query record indicated by their respective record types. The query record is accessed via the DepotQuery.

MethodgetDepotSearch
Description

Gets a depot search.

Returnosid.installation.DepotSearcha depot search
CompliancemandatoryThis method must be implemented.
MethodgetDepotSearchOrder
Description

Gets a depot search order. The DepotSearchOrder is supplied to a DepotSearch to specify the ordering of results.

Returnosid.installation.DepotSearchOrderthe depot search order
CompliancemandatoryThis method must be implemented.
MethodgetDepotsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.installation.DepotQuerydepotQuerythe depot query
osid.installation.DepotSearchdepotSearchthe depot search
Returnosid.installation.DepotSearchResultsthe depot search results
ErrorsNULL_ARGUMENT depotQuery or depotSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED depotQuery or depotSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDepotQueryFromInspector
Description

Gets a depot query from an inspector. The inspector is available from a DepotSearchResults.

Parametersosid.installation.DepotQueryInspectordepotQueryInspectora depot query inspector
Returnosid.installation.DepotQuerythe depot query
ErrorsNULL_ARGUMENT depotQueryInspector is null
UNSUPPORTED depotQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.