public interface RuleQuery extends OsidRuleQuery
This is the query for searching rules. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearEngineIdTerms()
Clears the engine
Id query terms. |
void |
clearEngineTerms()
Clears the engine query terms.
|
EngineQuery |
getEngineQuery()
Gets the query for an engine query.
|
RuleQueryRecord |
getRuleQueryRecord(Type ruleRecordType)
Gets the rule query record corresponding to the given
Rule
record Type. |
void |
matchEngineId(Id engineId,
boolean match)
Sets the engine
Id for this query to match rules
assigned to engines. |
boolean |
supportsEngineQuery()
Tests if an
EngineQuery is available. |
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 matchEngineId(Id engineId, boolean match)
Id
for this query to match rules
assigned to engines.engineId
- an engine Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- engineId
is
null
mandatory
- This method must be implemented. void clearEngineIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsEngineQuery()
EngineQuery
is available. true
if an engine query is available,
false
otherwisemandatory
- This method must be implemented. EngineQuery getEngineQuery()
OR
term.UnimplementedException
- supportsEngineQuery()
is false
optional
- This method must be implemented if
supportsEngineQuery()
is true.
void clearEngineTerms()
mandatory
- This method must be implemented. RuleQueryRecord getRuleQueryRecord(Type ruleRecordType) throws OperationFailedException
Rule
record Type.
Multiple record retrievals produce
a nested OR
term.ruleRecordType
- a rule record typeNullArgumentException
- ruleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(ruleRecordType)
is false
mandatory
- This method must be implemented.