| Interface | osid.installation.SiteQuery | ||
|---|---|---|---|
| Implements | osid.OsidObjectQuery | ||
| Description | 
                 This is the query for searching installations. Each method 
                match request produces an   | ||
| Method | matchInstallationId | ||
| Description | 
                     Sets the installation   | ||
| Parameters | osid.id.Id | installationId | a site  Id   | 
boolean | match |  true  for a positive match,  false  for a 
negative match  | |
| Errors | NULL_ARGUMENT |  installationId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearInstallationIdTerms | ||
| Description | 
                     Clears the installation   | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationQuery | ||
| Description | 
                     Tests if an   | ||
| Return | boolean |  true  if an installation query is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationQuery | ||
| Description | 
                     Gets the query for an installation. Multiple retrievals 
                    produce a nested   | ||
| Return | osid.installation.SiteQuery | the site query | |
| Errors | UNIMPLEMENTED |  supportsInstallationQuery()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsInstallationQuery() 
 is  true.   | |
| Method | matchAnyInstallation | ||
| Description | 
                     Matches sites with any installation.  | ||
| Parameters | boolean | match |  true  to match sites with any package,  false  
to match sites with no packages  | 
| Compliance | mandatory | This method must be implemented. | |
| Method | clearInstallationTerms | ||
| Description | 
                     Clears the installation query terms.  | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSiteQueryRecord | ||
| Description | 
                     Gets the site query record corresponding to the given 
                      | ||
| Parameters | osid.type.Type | siteRecordType | a site query record type | 
| Return | osid.installation.records.SiteQueryRecord | the site query record | |
| Errors | NULL_ARGUMENT |  siteRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(siteRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |