OSID - osid.cataloging.CatalogQuery Service Interface Definition

Interface	osid.cataloging.CatalogQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching catalogs. Each method specifies an `AND` term while multiple invocations of the same method produces a nested `OR.`
Method	matchId
Description	Matches an `Id` in this catalog. Multiple Ids are treated as a boolean `OR.`
Parameters	`osid.id.Id`	`id`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`id` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyId
Description	Matches catalogs that have any `Id` mapping.
Parameters	`boolean`	`match`	`true` to match catalogs with any `Id` mapping, `false` to match catalogs with no `Id` mapping
Compliance	`mandatory`		This method must be implemented.
Method	clearIdTerms
Description	Clears the `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorCatalogId
Description	Sets the catalog `Id` for this query to match catalogs that have the specified catalog as an ancestor.
Parameters	`osid.id.Id`	`catalogId`	a catalog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`catalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCatalogIdTerms
Description	Clears the ancestor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorCatalogQuery
Description	Tests if a `CatalogQuery` is available.
Return	`boolean`		`true` if a catalog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorCatalogQuery
Description	Gets the query for a catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.cataloging.CatalogQuery`		the catalog query
Errors	UNIMPLEMENTED		`supportsAncestorCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCatalogQuery()` is `true.`
Method	matchAnyAncestorCatalog
Description	Matches catalogs with any ancestor.
Parameters	`boolean`	`match`	`true` to match catalogs with any ancestor, `false` to match root catalogs
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCatalogTerms
Description	Clears the ancestor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantCatalogId
Description	Sets the catalog `Id` for this query to match catalogs that have the specified catalog as an descendant.
Parameters	`osid.id.Id`	`catalogId`	a catalog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`catalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCatalogIdTerms
Description	Clears the descendant `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantCatalogQuery
Description	Tests if a `CatalogQuery` is available.
Return	`boolean`		`true` if a catalog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantCatalogQuery
Description	Gets the query for a catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.cataloging.CatalogQuery`		the catalog query
Errors	UNIMPLEMENTED		`supportsDescendantCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCatalogQuery()` is `true.`
Method	matchAnyDescendantCatalog
Description	Matches catalogs with any descendant.
Parameters	`boolean`	`match`	`true` to match catalogs with any descendant, `false` to match leaf catalogs
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCatalogTerms
Description	Clears the descendant query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogQueryRecord
Description	Gets the catalog query record corresponding to the given `Catalog` record `Type.` Multiple record retrievals produce a boolean `OR` term.
Parameters	`osid.type.Type`	`catalogRecordType`	a catalog record type
Return	`osid.cataloging.records.CatalogQueryRecord`		the catalog query record
Errors	NULL_ARGUMENT		`catalogRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(catalogRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.