public interface SignalEnablerQuery extends OsidEnablerQuery
This is the query for searching signal 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 |
clearMapIdTerms()
Clears the map
Id query terms. |
void |
clearMapTerms()
Clears the map query terms.
|
void |
clearRuledSignalIdTerms()
Clears the signal
Id query terms. |
void |
clearRuledSignalTerms()
Clears the signal query terms.
|
MapQuery |
getMapQuery()
Gets the query for an map.
|
SignalQuery |
getRuledSignalQuery()
Gets the query for a signal.
|
SignalEnablerQueryRecord |
getSignalEnablerQueryRecord(Type signalEnablerRecordType)
Gets the signal enabler query record corresponding to the given
SignalEnabler record Type. |
void |
matchAnyRuledSignal(boolean match)
Matches rules mapped to any signal.
|
void |
matchMapId(Id mapId,
boolean match)
Matches enablers mapped to an map.
|
void |
matchRuledSignalId(Id signalId,
boolean match)
Matches enablers mapped to a signal.
|
boolean |
supportsMapQuery()
Tests if an
MapQuery is available. |
boolean |
supportsRuledSignalQuery()
Tests if a
SignalQuery 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 matchRuledSignalId(Id signalId, boolean match)
signalId
- the signal Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- signalId
is
null
mandatory
- This method must be implemented. void clearRuledSignalIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledSignalQuery()
SignalQuery
is available. true
if a signal query is available,
false
otherwisemandatory
- This method must be implemented. SignalQuery getRuledSignalQuery()
OR
term.UnimplementedException
-
supportsRuledSignalQuery()
is false
optional
- This method must be implemented if
supportsRuledSignalQuery()
is true.
void matchAnyRuledSignal(boolean match)
match
- true
for rules mapped to any signal,
false
to match rules mapped to no signalsmandatory
- This method must be implemented. void clearRuledSignalTerms()
mandatory
- This method must be implemented. void matchMapId(Id mapId, boolean match)
mapId
- the map Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. void clearMapIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsMapQuery()
MapQuery
is available. true
if an map query is available, false
otherwisemandatory
- This method must be implemented. MapQuery getMapQuery()
OR
term.UnimplementedException
- supportsMapQuery()
is false
optional
- This method must be implemented if
supportsMapQuery()
is true.
void clearMapTerms()
mandatory
- This method must be implemented. SignalEnablerQueryRecord getSignalEnablerQueryRecord(Type signalEnablerRecordType) throws OperationFailedException
SignalEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.signalEnablerRecordType
- a signal enabler record typeNullArgumentException
- signalEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalEnablerRecordType)
is false
mandatory
- This method must be implemented.