| Interface | osid.installation.InstallationQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| 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 | getSiteId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Site Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSite | ||
| Description |
Gets the | ||
| Return | osid.installation.Site | the Site associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSearchInstallations | ||
| Description |
Tests if this user can perform | ||
| Return | boolean | false if search methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useNormalizedVersionView | ||
| Description |
The returns from the lookup methods may omit multiple versions of the same installation. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useDenormalizedVersionView | ||
| Description |
All versions of the same installation are returned. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useNormalizedDependencyView | ||
| Description |
A normalized view uses a single | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useDenormalizedDependencyView | ||
| Description |
A denormalized view returns all dependencies. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getInstallationQuery | ||
| Description |
Gets an installation query. | ||
| Return | osid.installation.InstallationQuery | the installation query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationsByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.installation.InstallationQuery | installationQuery | the installation query |
| Return | osid.installation.InstallationList | the returned InstallationList | |
| Errors | NULL_ARGUMENT | installationQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | installationQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |