OSID Specifications
installation package
Version 3.0.0
installation package
Version 3.0.0
| Interface | osid.installation.DepotSearchSession | ||
|---|---|---|---|
| Implements | osid.installation.DepotQuerySession | ||
| Used By | osid.installation.InstallationManager | ||
osid.installation.InstallationProxyManager | |||
| Description |
This session provides methods for searching among
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
| ||
| Method | getDepotSearch | ||
| Description |
Gets a depot search. | ||
| Return | osid.installation.DepotSearch | a depot search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDepotSearchOrder | ||
| Description |
Gets a depot search order. The
| ||
| Return | osid.installation.DepotSearchOrder | the depot search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDepotsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.installation.DepotQuery | depotQuery | the depot query |
osid.installation.DepotSearch | depotSearch | the depot search | |
| Return | osid.installation.DepotSearchResults | the depot search results | |
| Errors | NULL_ARGUMENT | depotQuery or depotSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | depotQuery or depotSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDepotQueryFromInspector | ||
| Description |
Gets a depot query from an inspector. The inspector is
available from a | ||
| Parameters | osid.installation.DepotQueryInspector | depotQueryInspector | a depot query inspector |
| Return | osid.installation.DepotQuery | the depot query | |
| Errors | NULL_ARGUMENT | depotQueryInspector is null | |
| UNSUPPORTED | depotQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |