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

Interface	osid.resource.demographic.DemographicQuery
Implements	`osid.OsidRuleQuery`
Description	This is the query for searching demographics. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchIncludedDemographicId
Description	Matches demographics including the given 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	clearIncludedDemographicIdTerms
Description	Clears the demographic `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIncludedDemographicQuery
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	getIncludedDemographicQuery
Description	Gets the query for a demographic. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	UNIMPLEMENTED		`supportsIncludedDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdIncludedDemographicQuery()` is `true.`
Method	matchAnyIncludedDemographic
Description	Matches demographics including any demographic.
Parameters	`boolean`	`match`	`true` for demographics that include any demographic, `false` to match demographics including no demographics
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludedDemographicTerms
Description	Clears the demographic query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludedIntersectingDemographicId
Description	Matches demographics including the given intersecting 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	clearIncludedIntersectingDemographicIdTerms
Description	Clears the intersecting demographic `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIncludedIntersectingDemographicQuery
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	getIncludedIntersectingDemographicQuery
Description	Gets the query for an intersecting demographic. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	UNIMPLEMENTED		`supportsIncludedDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdIncludedDemographicQuery()` is `true.`
Method	matchAnyIncludedIntersectingDemographic
Description	Matches demographics including any intersecting demographic.
Parameters	`boolean`	`match`	`true` for demographics that include any intersecting demographic, `false` to match demographics including no intersecting demographics
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludedIntersectingDemographicTerms
Description	Clears the intersecting demographic query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludedExclusiveDemographicId
Description	Matches demographics including the given exclusive 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	clearIncludedExclusiveDemographicIdTerms
Description	Clears the exclusive demographic `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIncludedExclusiveDemographicQuery
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	getIncludedExclusiveDemographicQuery
Description	Gets the query for an exclusive demographic. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	UNIMPLEMENTED		`supportsIncludedDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdIncludedDemographicQuery()` is `true.`
Method	matchAnyIncludedExclusiveDemographic
Description	Matches demographics including any exclusive demographic.
Parameters	`boolean`	`match`	`true` for demographics that include any exclusive demographic, `false` to match demographics including no exclusive demographics
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludedExclusiveDemographicTerms
Description	Clears the demographic query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExcludedDemographicId
Description	Matches demographics excluding the given a 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	clearExcludedDemographicIdTerms
Description	Clears the excluded demographic `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsExcludedDemographicQuery
Description	Tests if a `DemographicQuery` is available to match demographics with an excluded demographic.
Return	`boolean`		`true` if a demographic query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExcludedDemographicQuery
Description	Gets the query for an excluded demographic. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	UNIMPLEMENTED		`supportsExcludedDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdExcludedDemographicQuery()` is `true.`
Method	matchAnyExcludedDemographic
Description	Matches demographics excluding any demographic.
Parameters	`boolean`	`match`	`true` for demographics with any excluded demographic, `false` to match demographics with no excluded demographics
Compliance	`mandatory`		This method must be implemented.
Method	clearExcludedDemographicTerms
Description	Clears the excluded demographic query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludedResourceId
Description	Matches demographics including the given resource.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludedResourceIdTerms
Description	Clears the included resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIncludedResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsIncludedResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdIncludedResourceQuery()` is `true.`
Method	matchAnyIncludedResource
Description	Matches demographics including any resource.
Parameters	`boolean`	`match`	`true` for demographics that include any resource, `false` to match demographics including no resources
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludedResourceTerms
Description	Clears the included resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExcludedResourceId
Description	Matches demographics excluding the given resource.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExcludedResourceIdTerms
Description	Clears the excluded resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsExcludedResourceQuery
Description	Tests if a `ResourceQuery` is available to match demographics with an excluded resource.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExcludedResourceQuery
Description	Gets the query for an excluded resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsExcludedResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdExcludedResourceQuery()` is `true.`
Method	matchAnyExcludedResource
Description	Matches demographics excluding any resource.
Parameters	`boolean`	`match`	`true` for demographics that exclude any resource, `false` to match demographics excluding no resources
Compliance	`mandatory`		This method must be implemented.
Method	clearExcludedResourceTerms
Description	Clears the excluded resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResultingResourceId
Description	Matches demographics resulting in the given resource.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResultingResourceIdTerms
Description	Clears the resulting resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultingResourceQuery
Description	Tests if a `ResourceQuery` is available to match demographics resulting in a resource.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultingResourceQuery
Description	Gets the query for a resulting resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResultingResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsdResultingResourceQuery()` is `true.`
Method	matchAnyResultingResource
Description	Matches demographics that have any resulting resource.
Parameters	`boolean`	`match`	`true` for demographics that have any resulting resource, `false` to match demographics with no resulting resources
Compliance	`mandatory`		This method must be implemented.
Method	clearResultingResourceTerms
Description	Clears the resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBinId
Description	Matches 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	getDemographicQueryRecord
Description	Gets the demographic query record corresponding to the given `Demographic` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`demographicRecordType`	a demographic record type
Return	`osid.resource.demographic.records.DemographicQueryRecord`		the demographic query record
Errors	NULL_ARGUMENT		`demographicRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(demographicRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.