OSID - osid.installation.DepotQuery Service Interface Definition

Interface	osid.installation.DepotQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching depots. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
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.
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	matchAnyPackage
Description	Matches depots that have any package.
Parameters	`boolean`	`match`	`true` to match depots with any packages, `false` to match depots with no packages
Compliance	`mandatory`		This method must be implemented.
Method	clearPackageTerms
Description	Clears the package query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorDepotId
Description	Sets the depot `Id` for this query to match depots that have the specified depot as an ancestor.
Parameters	`osid.id.Id`	`depotId`	a depot `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`depotId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorDepotIdTerms
Description	Clears the ancestor depot `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorDepotQuery
Description	Tests if a `DepotQuery` is available.
Return	`boolean`		`true` if a depot query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorDepotQuery
Description	Gets the query for a Depot. Multiple retrievals produce a nested `OR` term.
Return	`osid.installation.DepotQuery`		the depot query
Errors	UNIMPLEMENTED		`supportsAncestorDepotQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorDepotQuery()` is `true.`
Method	matchAnyAncestorDepot
Description	Matches depots with any ancestor.
Parameters	`boolean`	`match`	`true` to match depots with any ancestor, `false` to match root depots
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorDepotTerms
Description	Clears the ancestor depot query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantDepotId
Description	Sets the depot `Id` for this query to match depots that have the specified depot as a descendant.
Parameters	`osid.id.Id`	`depotId`	a depot `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`depotId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantDepotIdTerms
Description	Clears the descendant depot `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantDepotQuery
Description	Tests if a `DepotQuery` is available.
Return	`boolean`		`true` if a depot query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantDepotQuery
Description	Gets the query for a Depot. Multiple retrievals produce a nested `OR` term.
Return	`osid.installation.DepotQuery`		the depot query
Errors	UNIMPLEMENTED		`supportsDescendantDepotQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantDepotQuery()` is `true.`
Method	matchAnyDescendantDepot
Description	Matches depots with any descendant.
Parameters	`boolean`	`match`	`true` to match depots with any descendant, `false` to match leaf depots
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantDepotTerms
Description	Clears the descendant depot query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getDepotQueryRecord
Description	Gets the depot query record corresponding to the given `Depot` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`depotRecordType`	a depot record type
Return	`osid.installation.records.DepotQueryRecord`		the depot query record
Errors	NULL_ARGUMENT		`depotRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(depotRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.