public interface DemographicQuery extends OsidRuleQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearBinIdTerms()
Clears the bin
Id query terms. |
void |
clearBinTerms()
Clears the bin query terms.
|
void |
clearExcludedDemographicIdTerms()
Clears the excluded demographic
Id query terms. |
void |
clearExcludedDemographicTerms()
Clears the excluded demographic query terms.
|
void |
clearExcludedResourceIdTerms()
Clears the excluded resource
Id query terms. |
void |
clearExcludedResourceTerms()
Clears the excluded resource query terms.
|
void |
clearIncludedDemographicIdTerms()
Clears the demographic
Id query terms. |
void |
clearIncludedDemographicTerms()
Clears the demographic query terms.
|
void |
clearIncludedExclusiveDemographicIdTerms()
Clears the exclusive demographic
Id query terms. |
void |
clearIncludedExclusiveDemographicTerms()
Clears the demographic query terms.
|
void |
clearIncludedIntersectingDemographicIdTerms()
Clears the intersecting demographic
Id query terms. |
void |
clearIncludedIntersectingDemographicTerms()
Clears the intersecting demographic query terms.
|
void |
clearIncludedResourceIdTerms()
Clears the included resource
Id query terms. |
void |
clearIncludedResourceTerms()
Clears the included resource query terms.
|
void |
clearResultingResourceIdTerms()
Clears the resulting resource
Id query terms. |
void |
clearResultingResourceTerms()
Clears the resource query terms.
|
BinQuery |
getBinQuery()
Gets the query for a bin.
|
DemographicQueryRecord |
getDemographicQueryRecord(Type demographicRecordType)
Gets the demographic query record corresponding to the given
Demographic record Type. |
DemographicQuery |
getExcludedDemographicQuery()
Gets the query for an excluded demographic.
|
ResourceQuery |
getExcludedResourceQuery()
Gets the query for an excluded resource.
|
DemographicQuery |
getIncludedDemographicQuery()
Gets the query for a demographic.
|
DemographicQuery |
getIncludedExclusiveDemographicQuery()
Gets the query for an exclusive demographic.
|
DemographicQuery |
getIncludedIntersectingDemographicQuery()
Gets the query for an intersecting demographic.
|
ResourceQuery |
getIncludedResourceQuery()
Gets the query for a resource.
|
ResourceQuery |
getResultingResourceQuery()
Gets the query for a resulting resource.
|
void |
matchAnyExcludedDemographic(boolean match)
Matches demographics excluding any demographic.
|
void |
matchAnyExcludedResource(boolean match)
Matches demographics excluding any resource.
|
void |
matchAnyIncludedDemographic(boolean match)
Matches demographics including any demographic.
|
void |
matchAnyIncludedExclusiveDemographic(boolean match)
Matches demographics including any exclusive demographic.
|
void |
matchAnyIncludedIntersectingDemographic(boolean match)
Matches demographics including any intersecting demographic.
|
void |
matchAnyIncludedResource(boolean match)
Matches demographics including any resource.
|
void |
matchAnyResultingResource(boolean match)
Matches demographics that have any resulting resource.
|
void |
matchBinId(Id binId,
boolean match)
Matches mapped to the bin.
|
void |
matchExcludedDemographicId(Id demographicId,
boolean match)
Matches demographics excluding the given a demographic.
|
void |
matchExcludedResourceId(Id resourceId,
boolean match)
Matches demographics excluding the given resource.
|
void |
matchIncludedDemographicId(Id demographicId,
boolean match)
Matches demographics including the given demographic.
|
void |
matchIncludedExclusiveDemographicId(Id demographicId,
boolean match)
Matches demographics including the given exclusive demographic.
|
void |
matchIncludedIntersectingDemographicId(Id demographicId,
boolean match)
Matches demographics including the given intersecting demographic.
|
void |
matchIncludedResourceId(Id resourceId,
boolean match)
Matches demographics including the given resource.
|
void |
matchResultingResourceId(Id resourceId,
boolean match)
Matches demographics resulting in the given resource.
|
boolean |
supportsBinQuery()
Tests if a
BinQuery is available. |
boolean |
supportsExcludedDemographicQuery()
Tests if a
DemographicQuery is available to match
demographics with an excluded demographic. |
boolean |
supportsExcludedResourceQuery()
Tests if a
ResourceQuery is available to match
demographics with an excluded resource. |
boolean |
supportsIncludedDemographicQuery()
Tests if a
DemographicQuery is available. |
boolean |
supportsIncludedExclusiveDemographicQuery()
Tests if a
DemographicQuery is available. |
boolean |
supportsIncludedIntersectingDemographicQuery()
Tests if a
DemographicQuery is available. |
boolean |
supportsIncludedResourceQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsResultingResourceQuery()
Tests if a
ResourceQuery is available to match
demographics resulting in a resource. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchIncludedDemographicId(Id demographicId, boolean match)
demographicId
- the demographic Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- demographicId
is
null
mandatory
- This method must be implemented. void clearIncludedDemographicIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIncludedDemographicQuery()
DemographicQuery
is available. true
if a demographic query is available,
false
otherwisemandatory
- This method must be implemented. DemographicQuery getIncludedDemographicQuery()
OR
term.UnimplementedException
-
supportsIncludedDemographicQuery()
is false
optional
- This method must be implemented if
supportsdIncludedDemographicQuery()
is
true.
void matchAnyIncludedDemographic(boolean match)
match
- true
for demographics that include any
demographic, false
to match demographics
including no demographicsmandatory
- This method must be implemented. void clearIncludedDemographicTerms()
mandatory
- This method must be implemented. void matchIncludedIntersectingDemographicId(Id demographicId, boolean match)
demographicId
- the demographic Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- demographicId
is
null
mandatory
- This method must be implemented. void clearIncludedIntersectingDemographicIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIncludedIntersectingDemographicQuery()
DemographicQuery
is available. true
if a demographic query is available,
false
otherwisemandatory
- This method must be implemented. DemographicQuery getIncludedIntersectingDemographicQuery()
OR
term.UnimplementedException
-
supportsIncludedDemographicQuery()
is false
optional
- This method must be implemented if
supportsdIncludedDemographicQuery()
is
true.
void matchAnyIncludedIntersectingDemographic(boolean match)
match
- true
for demographics that include any
intersecting demographic, false
to match
demographics including no intersecting demographicsmandatory
- This method must be implemented. void clearIncludedIntersectingDemographicTerms()
mandatory
- This method must be implemented. void matchIncludedExclusiveDemographicId(Id demographicId, boolean match)
demographicId
- the demographic Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- demographicId
is
null
mandatory
- This method must be implemented. void clearIncludedExclusiveDemographicIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIncludedExclusiveDemographicQuery()
DemographicQuery
is available. true
if a demographic query is available,
false
otherwisemandatory
- This method must be implemented. DemographicQuery getIncludedExclusiveDemographicQuery()
OR
term.UnimplementedException
-
supportsIncludedDemographicQuery()
is false
optional
- This method must be implemented if
supportsdIncludedDemographicQuery()
is
true.
void matchAnyIncludedExclusiveDemographic(boolean match)
match
- true
for demographics that include any
exclusive demographic, false
to match
demographics including no exclusive demographicsmandatory
- This method must be implemented. void clearIncludedExclusiveDemographicTerms()
mandatory
- This method must be implemented. void matchExcludedDemographicId(Id demographicId, boolean match)
demographicId
- the demographic Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- demographicId
is
null
mandatory
- This method must be implemented. void clearExcludedDemographicIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsExcludedDemographicQuery()
DemographicQuery
is available to match
demographics with an excluded demographic. true
if a demographic query is available,
false
otherwisemandatory
- This method must be implemented. DemographicQuery getExcludedDemographicQuery()
OR
term.UnimplementedException
-
supportsExcludedDemographicQuery()
is false
optional
- This method must be implemented if
supportsdExcludedDemographicQuery()
is
true.
void matchAnyExcludedDemographic(boolean match)
match
- true
for demographics with any excluded
demographic, false
to match demographics with
no excluded demographicsmandatory
- This method must be implemented. void clearExcludedDemographicTerms()
mandatory
- This method must be implemented. void matchIncludedResourceId(Id resourceId, boolean match)
resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearIncludedResourceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIncludedResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getIncludedResourceQuery()
OR
term.UnimplementedException
-
supportsIncludedResourceQuery()
is false
optional
- This method must be implemented if
supportsdIncludedResourceQuery()
is true.
void matchAnyIncludedResource(boolean match)
match
- true
for demographics that include any
resource, false
to match demographics including
no resourcesmandatory
- This method must be implemented. void clearIncludedResourceTerms()
mandatory
- This method must be implemented. void matchExcludedResourceId(Id resourceId, boolean match)
resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearExcludedResourceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsExcludedResourceQuery()
ResourceQuery
is available to match
demographics with an excluded resource. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getExcludedResourceQuery()
OR
term.UnimplementedException
-
supportsExcludedResourceQuery()
is false
optional
- This method must be implemented if
supportsdExcludedResourceQuery()
is true.
void matchAnyExcludedResource(boolean match)
match
- true
for demographics that exclude any
resource, false
to match demographics excluding
no resourcesmandatory
- This method must be implemented. void clearExcludedResourceTerms()
mandatory
- This method must be implemented. void matchResultingResourceId(Id resourceId, boolean match)
resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResultingResourceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsResultingResourceQuery()
ResourceQuery
is available to match
demographics resulting in a resource. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResultingResourceQuery()
OR
term.UnimplementedException
-
supportsResultingResourceQuery()
is false
optional
- This method must be implemented if
supportsdResultingResourceQuery()
is true.
void matchAnyResultingResource(boolean match)
match
- true
for demographics that have any
resulting resource, false
to match demographics
with no resulting resourcesmandatory
- This method must be implemented. void clearResultingResourceTerms()
mandatory
- This method must be implemented. void matchBinId(Id binId, boolean match)
binId
- the bin Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- binId
is
null
mandatory
- This method must be implemented. void clearBinIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsBinQuery()
BinQuery
is available. true
if a bin query is available, false
otherwisemandatory
- This method must be implemented. BinQuery getBinQuery()
OR
term.UnimplementedException
- supportsBinQuery()
is false
optional
- This method must be implemented if
supportsBinQuery()
is true.
void clearBinTerms()
mandatory
- This method must be implemented. DemographicQueryRecord getDemographicQueryRecord(Type demographicRecordType) throws OperationFailedException
Demographic
record Type.
Multiple record
retrievals produce a nested OR
term.demographicRecordType
- a demographic record typeNullArgumentException
- demographicRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(demographicRecordType)
is false
mandatory
- This method must be implemented.