OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicEnablerQuery
Implementsosid.OsidEnablerQuery
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.

MethodmatchRuledDemographicId
Description

Matches enablers mapped to the demographic.

Parametersosid.id.IddemographicIdthe demographic Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT demographicId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledDemographicIdTerms
Description

Clears the demographic Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledDemographicQuery
Description

Tests if a DemographicQuery is available.

Returnboolean true if a demographic query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledDemographicQuery
Description

Gets the query for a demographic. Multiple retrievals produce a nested OR term.

Returnosid.resource.demographic.DemographicQuerythe demographic query
ErrorsUNIMPLEMENTED supportsRuledDemographicQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledDemographicQuery() is true.
MethodmatchAnyRuledDemographic
Description

Matches enablers mapped to any demographic.

Parametersbooleanmatch true for enablers mapped to any demographic, false to match enablers mapped to no demographics
CompliancemandatoryThis method must be implemented.
MethodclearRuledDemographicTerms
Description

Clears the demographic query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBinId
Description

Matches enablers mapped to the bin.

Parametersosid.id.IdbinIdthe bin Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT binId is null
CompliancemandatoryThis method must be implemented.
MethodclearBinIdTerms
Description

Clears the bin Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBinQuery
Description

Tests if a BinQuery is available.

Returnboolean true if a bin query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBinQuery
Description

Gets the query for a bin. Multiple retrievals produce a nested OR term.

Returnosid.resource.BinQuerythe bin query
ErrorsUNIMPLEMENTED supportsBinQuery() is false
ComplianceoptionalThis method must be implemented if supportsBinQuery() is true.
MethodclearBinTerms
Description

Clears the bin query terms.

CompliancemandatoryThis method must be implemented.
MethodgetDemographicEnablerQueryRecord
Description

Gets the demographic enabler query record corresponding to the given DemographicEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypedemographicEnablerRecordTypea demographic enabler record type
Returnosid.resource.demographic.records.DemographicEnablerQueryRecordthe demographic enabler query record
ErrorsNULL_ARGUMENT demographicEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(demographicEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.