public interface SequenceRuleEnablerQuery extends OsidEnablerQuery
This is the query for searching sequence rule enablers. Each method
match specifies a AND
term while multiple invocations of
the same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearBankIdTerms()
Clears the bank
Id query terms. |
void |
clearBankTerms()
Clears the bank query terms.
|
void |
clearRuledSequenceRuleIdTerms()
Clears the sequence rule
Id query terms. |
void |
clearRuledSequenceRuleTerms()
Clears the sequence rule query terms.
|
BankQuery |
getBankQuery()
Gets the query for a bank.
|
SequenceRuleQuery |
getRuledSequenceRuleQuery()
Gets the query for a sequence rule.
|
SequenceRuleEnablerQueryRecord |
getSequenceRuleEnablerQueryRecord(Type sequenceRuleEnablerRecordType)
Gets the sequence rule enabler query record corresponding to the given
SequenceRuleEnabler record Type. |
void |
matchAnyRuledSequenceRule(boolean match)
Matches enablers mapped to any sequence rule.
|
void |
matchBankId(Id bankId,
boolean match)
Matches enablers mapped to the bank.
|
void |
matchRuledSequenceRuleId(Id sequenceRuleId,
boolean match)
Matches enablers mapped to the sequence rule.
|
boolean |
supportsBankQuery()
Tests if an
BankQuery is available. |
boolean |
supportsRuledSequenceRuleQuery()
Tests if a
SequenceRuleQuery 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 matchRuledSequenceRuleId(Id sequenceRuleId, boolean match)
sequenceRuleId
- the sequence rule Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- sequenceRuleId
is null
mandatory
- This method must be implemented. void clearRuledSequenceRuleIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledSequenceRuleQuery()
SequenceRuleQuery
is available. true
if a sequence rule query is available,
false
otherwisemandatory
- This method must be implemented. SequenceRuleQuery getRuledSequenceRuleQuery()
OR
term.UnimplementedException
-
supportsRuledSequenceRuleQuery()
is false
optional
- This method must be implemented if
supportsRuledSequenceRuleQuery()
is true.
void matchAnyRuledSequenceRule(boolean match)
match
- true
for enablers mapped to any sequence
rule, false
to match enablers mapped to no
sequence rulesmandatory
- This method must be implemented. void clearRuledSequenceRuleTerms()
mandatory
- This method must be implemented. void matchBankId(Id bankId, boolean match)
bankId
- the bank Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- bankId
is
null
mandatory
- This method must be implemented. void clearBankIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsBankQuery()
BankQuery
is available. true
if a bank query is available, false
otherwisemandatory
- This method must be implemented. BankQuery getBankQuery()
OR
term.UnimplementedException
- supportsBankQuery()
is false
optional
- This method must be implemented if
supportsBankQuery()
is true.
void clearBankTerms()
mandatory
- This method must be implemented. SequenceRuleEnablerQueryRecord getSequenceRuleEnablerQueryRecord(Type sequenceRuleEnablerRecordType) throws OperationFailedException
SequenceRuleEnabler
record Type.
Multiple record retrievals produce a nested OR
term.sequenceRuleEnablerRecordType
- a sequence rule enabler record
typeNullArgumentException
-
sequenceRuleEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(sequenceRuleEnablerRecordType)
is
false
mandatory
- This method must be implemented.