public interface ValueEnablerQuery extends OsidEnablerQuery
This is the query for searching value enablers. 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 |
clearConfigurationIdTerms()
Clears the configuration
Id query terms. |
void |
clearConfigurationTerms()
Clears the configuration query terms.
|
void |
clearRuledValueIdTerms()
Clears the value
Id query terms. |
void |
clearRuledValueTerms()
Clears the value query terms.
|
ConfigurationQuery |
getConfigurationQuery()
Gets the query for a configuration.
|
ValueQuery |
getRuledValueQuery()
Gets the query for a value.
|
ValueEnablerQueryRecord |
getValueEnablerQueryRecord(Type valueEnablerRecordType)
Gets the value enabler query record corresponding to the given
ValueEnabler record Type. |
void |
matchAnyRuledValue(boolean match)
Matches enablers mapped to any value.
|
void |
matchConfigurationId(Id configurationId,
boolean match)
Matches enablers mapped to the configuration.
|
void |
matchRuledValueId(Id valueId,
boolean match)
Matches enablers mapped to the value.
|
boolean |
supportsConfigurationQuery()
Tests if a
ConfigurationQuery is available. |
boolean |
supportsRuledValueQuery()
Tests if a
ValueQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledValueId(Id valueId, boolean match)
valueId
- the value Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- valueId
is
null
mandatory
- This method must be implemented. void clearRuledValueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledValueQuery()
ValueQuery
is available. true
if a value query is available,
false
otherwisemandatory
- This method must be implemented. ValueQuery getRuledValueQuery()
OR
term.UnimplementedException
-
supportsRuleValueQuery()
is false
optional
- This method must be implemented if
supportsRuledValueQuery()
is true.
void matchAnyRuledValue(boolean match)
match
- true
for enablers mapped to any value,
false
to match enablers mapped to no valuemandatory
- This method must be implemented. void clearRuledValueTerms()
mandatory
- This method must be implemented. void matchConfigurationId(Id configurationId, boolean match)
configurationId
- the configuration Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- configurationId
is null
mandatory
- This method must be implemented. void clearConfigurationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsConfigurationQuery()
ConfigurationQuery
is available. true
if a configuration query is available,
false
otherwisemandatory
- This method must be implemented. ConfigurationQuery getConfigurationQuery()
OR
term.UnimplementedException
-
supportsConfigurationQuery()
is false
optional
- This method must be implemented if
supportsConfigurationQuery()
is true.
void clearConfigurationTerms()
mandatory
- This method must be implemented. ValueEnablerQueryRecord getValueEnablerQueryRecord(Type valueEnablerRecordType) throws OperationFailedException
ValueEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.valueEnablerRecordType
- a value enabler record typeNullArgumentException
- valueEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueEnablerRecordType)
is false
mandatory
- This method must be implemented.