OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.InstallationQuery
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.

MethodmatchSiteId
Description

Sets the site Id for this query.

Parametersosid.id.IdsiteIda site Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT siteId is null
CompliancemandatoryThis method must be implemented.
MethodclearSiteIdTerms
Description

Clears the site Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSiteQuery
Description

Tests if a SiteQuery is available for querying sites.

Returnboolean true if a site query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSiteQuery
Description

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

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

Clears the site query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPackageId
Description

Sets the package Id for this query.

Parametersosid.id.IdpackageIda package Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT packageId is null
CompliancemandatoryThis method must be implemented.
MethodclearPackageIdTerms
Description

Clears the package Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPackageQuery
Description

Tests if a PackageQuery is available for querying agents.

Returnboolean true if a package query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPackageQuery
Description

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

Returnosid.installation.PackageQuerythe package query
ErrorsUNIMPLEMENTED supportsPackageQuery() is false
ComplianceoptionalThis method must be implemented if supportsPackageQuery() is true.
MethodclearPackageTerms
Description

Clears the package query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInstallDate
Description

Matches the install date between the given times inclusive.

Parametersosid.calendaring.DateTimefromstarting range
osid.calendaring.DateTimetoending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
CompliancemandatoryThis method must be implemented.
MethodclearInstallDateTerms
Description

Clears the install date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAgentId
Description

Sets the agent Id for this query.

Parametersosid.id.IdagentIdan agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgentIdTerms
Description

Clears the agent Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an AgentQuery is available for querying agents.

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

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

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() is true.
MethodclearAgentTerms
Description

Clears the agent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLastCheckDate
Description

Matches the last checked date between the given times inclusive.

Parametersosid.calendaring.DateTimefromstarting range
osid.calendaring.DateTimetoending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
CompliancemandatoryThis method must be implemented.
MethodclearLastCheckDateTerms
Description

Clears the last check date query terms.

CompliancemandatoryThis method must be implemented.
MethodgetInstallationQueryRecord
Description

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

Parametersosid.type.TypeinstallationRecordTypean installation query record type
Returnosid.installation.records.InstallationQueryRecordthe installation query record
ErrorsNULL_ARGUMENT installationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(installationRecordType) is false
CompliancemandatoryThis method must be implemented.