OSID - osid.installation.InstallationQuery Service Interface Definition

Interface	osid.installation.InstallationQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.installation.InstallationQuerySession`
	`osid.installation.InstallationSearchSession`
	`osid.installation.PackageQuery`
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` .
Method	matchSiteId
Description	Sets the site `Id` for this query.
Parameters	`osid.id.Id`	`siteId`	a site `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`siteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSiteIdTerms
Description	Clears the site `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSiteQuery
Description	Tests if a `SiteQuery` is available for querying sites.
Return	`boolean`		`true` if a site query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSiteQuery
Description	Gets the query for a site. Multiple retrievals produce a nested `OR` term.
Return	`osid.installation.SiteQuery`		the site query
Errors	UNIMPLEMENTED		`supportsSiteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSiteQuery()` is `true` .
Method	clearSiteTerms
Description	Clears the site query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPackageId
Description	Sets the package `Id` for this query.
Parameters	`osid.id.Id`	`packageId`	a package `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`packageId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPackageIdTerms
Description	Clears the package `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPackageQuery
Description	Tests if a `PackageQuery` is available for querying agents.
Return	`boolean`		`true` if a package query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPackageQuery
Description	Gets the query for a package. Multiple retrievals produce a nested `OR` term.
Return	`osid.installation.PackageQuery`		the package query
Errors	UNIMPLEMENTED		`supportsPackageQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageQuery()` is `true` .
Method	clearPackageTerms
Description	Clears the package query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInstallDate
Description	Matches the install date between the given times inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting range
	`osid.calendaring.DateTime`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is `less than from`
Compliance	`mandatory`		This method must be implemented.
Method	clearInstallDateTerms
Description	Clears the install date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAgentId
Description	Sets the agent `Id` for this query.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentIdTerms
Description	Clears the agent `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an `AgentQuery` is available for querying agents.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true` .
Method	clearAgentTerms
Description	Clears the agent query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLastCheckDate
Description	Matches the last checked date between the given times inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting range
	`osid.calendaring.DateTime`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is `less than from`
Compliance	`mandatory`		This method must be implemented.
Method	clearLastCheckDateTerms
Description	Clears the last check date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationQueryRecord
Description	Gets the installation query record corresponding to the given `Installation` record `Type` . Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`installationRecordType`	an installation query record type
Return	`osid.installation.records.InstallationQueryRecord`		the installation query record
Errors	NULL_ARGUMENT		`installationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(installationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.