OSID - osid.cataloging.rules.CatalogEnablerQuery Service Interface Definition

Interface	osid.cataloging.rules.CatalogEnablerQuery
Implements	`osid.OsidEnablerQuery`
Description	This is the query for searching catalog enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchRuledCatalogId
Description	Matches enablers mapped to the catalog.
Parameters	`osid.id.Id`	`catalogId`	the 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	clearRuledCatalogIdTerms
Description	Clears the catalog `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledCatalogQuery
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	getRuledCatalogQuery
Description	Gets the query for a catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.cataloging.CatalogQuery`		the catalog query
Errors	UNIMPLEMENTED		`supportsRuledCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledCatalogQuery()` is `true.`
Method	matchAnyRuledCatalog
Description	Matches enablers mapped to any catalog.
Parameters	`boolean`	`match`	`true` for enablers mapped to any catalog, `false` to match enablers mapped to no catalog
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCatalogTerms
Description	Clears the catalog query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCatalogId
Description	Matches enablers mapped to the catalog.
Parameters	`osid.id.Id`	`catalogId`	the 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	clearCatalogIdTerms
Description	Clears the catalog `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogQuery
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	getCatalogQuery
Description	Gets the query for a catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.cataloging.CatalogQuery`		the catalog query
Errors	UNIMPLEMENTED		`supportsCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogQuery()` is `true.`
Method	clearCatalogTerms
Description	Clears the catalog query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerQueryRecord
Description	Gets the catalog enabler query record corresponding to the given `CatalogEnabler` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`catalogEnablerRecordType`	a catalog enabler record type
Return	`osid.cataloging.rules.records.CatalogEnablerQueryRecord`		the catalog enabler query record
Errors	NULL_ARGUMENT		`catalogEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(catalogEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.