Interface | osid.installation.InstallationSearchSession | ||
---|---|---|---|
Implements | osid.installation.InstallationQuerySession | ||
Description |
This session provides methods for searching Installations may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getInstallationSearch | ||
Description |
Gets an installation search. | ||
Return | osid.installation.InstallationSearch | the installation search | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstallationSearchOrder | ||
Description |
Gets an installation search order. The | ||
Return | osid.installation.InstallationSearchOrder | the installation search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstallationsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.installation.InstallationQuery | installationQuery | the installation query |
osid.installation.InstallationSearch | installationSearch | the installation search | |
Return | osid.installation.InstallationSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | installationQuery or installationSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | installationSearch or installationQuery is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInstallationsQueryFromInspector | ||
Description |
Gets a installation query from an inspector. The
inspector is available from a | ||
Parameters | osid.installation.InstallationQueryInspector | installatonQueryInspector | a installation query inspector |
Return | osid.installation.InstallationQuery | the installaton query | |
Errors | NULL_ARGUMENT | installationQueryInspector is null | |
UNSUPPORTED | installationQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |