OSID - osid.resource.demographic.DemographicEnablerQuery Service Interface Definition

Interface	osid.resource.demographic.DemographicEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.resource.demographic.DemographicEnablerQuerySession`
	`osid.resource.demographic.DemographicEnablerSearchSession`
	`osid.resource.demographic.DemographicEnablerSmartBinSession`
Description	This is the query for searching demographic enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledDemographicId
Description	Matches enablers mapped to the demographic.
Parameters	`osid.id.Id`	`demographicId`	the demographic `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`demographicId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDemographicIdTerms
Description	Clears the demographic `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledDemographicQuery
Description	Tests if a `DemographicQuery` is available.
Return	`boolean`		`true` if a demographic query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledDemographicQuery
Description	Gets the query for a demographic. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	UNIMPLEMENTED		`supportsRuledDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledDemographicQuery()` is `true`.
Method	matchAnyRuledDemographic
Description	Matches enablers mapped to any demographic.
Parameters	`boolean`	`match`	`true` for enablers mapped to any demographic, `false` to match enablers mapped to no demographics
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDemographicTerms
Description	Clears the demographic query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBinId
Description	Matches enablers mapped to the bin.
Parameters	`osid.id.Id`	`binId`	the bin `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`binId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBinIdTerms
Description	Clears the bin `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinQuery
Description	Tests if a `BinQuery` is available.
Return	`boolean`		`true` if a bin query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBinQuery
Description	Gets the query for a bin. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.BinQuery`		the bin query
Errors	UNIMPLEMENTED		`supportsBinQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBinQuery()` is `true`.
Method	clearBinTerms
Description	Clears the bin query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablerQueryRecord
Description	Gets the demographic enabler query record corresponding to the given `DemographicEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`demographicEnablerRecordType`	a demographic enabler record type
Return	`osid.resource.demographic.records.DemographicEnablerQueryRecord`		the demographic enabler query record
Errors	NULL_ARGUMENT		`demographicEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(demographicEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.