OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.SiteQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching installations. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchInstallationId
Description

Sets the installation Id for this query.

Parametersosid.id.IdinstallationIda site Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT installationId is null
CompliancemandatoryThis method must be implemented.
MethodclearInstallationIdTerms
Description

Clears the installation Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInstallationQuery
Description

Tests if an InstallationQuery is available for querying installations.

Returnboolean true if an installation query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInstallationQuery
Description

Gets the query for an installation. Multiple retrievals produce a nested OR term.

Returnosid.installation.SiteQuerythe site query
ErrorsUNIMPLEMENTED supportsInstallationQuery() is false
ComplianceoptionalThis method must be implemented if supportsInstallationQuery() is true.
MethodmatchAnyInstallation
Description

Matches sites with any installation.

Parametersbooleanmatch true to match sites with any package, false to match sites with no packages
CompliancemandatoryThis method must be implemented.
MethodclearInstallationTerms
Description

Clears the installation query terms.

CompliancemandatoryThis method must be implemented.
MethodgetSiteQueryRecord
Description

Gets the site query record corresponding to the given Site record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypesiteRecordTypea site query record type
Returnosid.installation.records.SiteQueryRecordthe site query record
ErrorsNULL_ARGUMENT siteRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(siteRecordType) is false
CompliancemandatoryThis method must be implemented.