public interface EngineQuery extends OsidCatalogQuery
This is the query for searching for engines. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorEngineIdTerms()
Clears the ancestor engine
Id query terms. |
void |
clearAncestorEngineTerms()
Clears the ancestor engine query terms.
|
void |
clearDescendantEngineIdTerms()
Clears the descendant engine
Id query terms. |
void |
clearDescendantEngineTerms()
Clears the descendant engine query terms.
|
void |
clearRuleIdTerms()
Clears the rule
Id query terms. |
void |
clearRuleTerms()
Clears the rule query terms.
|
EngineQuery |
getAncestorEngineQuery()
Gets the query for an engine.
|
EngineQuery |
getDescendantEngineQuery()
Gets the query for an engine.
|
EngineQueryRecord |
getEngineQueryRecord(Type engineRecordType)
Gets the engine query record corresponding to the given
Engine
record Type. |
RuleQuery |
getRuleQuery()
Gets the query for a rule.
|
void |
matchAncestorEngineId(Id engineId,
boolean match)
Sets the engine
Id for this query to match engines that
have the specified engine as an ancestor. |
void |
matchAnyAncestorEngine(boolean match)
Matches engines with any ancestor.
|
void |
matchAnyDescendantEngine(boolean match)
Matches engines with any descendant.
|
void |
matchAnyRule(boolean match)
Matches engines with any riule.
|
void |
matchDescendantEngineId(Id engineId,
boolean match)
Sets the engine
Id for this query to match engines that
have the specified engine as a descendant. |
void |
matchRuleId(Id ruleId,
boolean match)
Sets the rule
Id for this query to match rules assigned
to engines. |
boolean |
supportsAncestorEngineQuery()
Tests if an
EngineQuery is available. |
boolean |
supportsDescendantEngineQuery()
Tests if an
EngineQuery is available. |
boolean |
supportsRuleQuery()
Tests if a rule query is available.
|
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchRuleId(Id ruleId, boolean match)
Id
for this query to match rules assigned
to engines.ruleId
- a rule Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ruleId
is
null
mandatory
- This method must be implemented. void clearRuleIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuleQuery()
true
if a rule query is available, false
otherwisemandatory
- This method must be implemented. RuleQuery getRuleQuery()
UnimplementedException
- supportsRuleQuery()
is false
optional
- This method must be implemented if
supportsRuleQuery()
is true.
void matchAnyRule(boolean match)
match
- true
to match engines with any rule,,
false
to match engines with no rulesmandatory
- This method must be implemented. void clearRuleTerms()
mandatory
- This method must be implemented. void matchAncestorEngineId(Id engineId, boolean match)
Id
for this query to match engines that
have the specified engine as an ancestor.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 clearAncestorEngineIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorEngineQuery()
EngineQuery
is available. true
if an engine query is available,
false
otherwisemandatory
- This method must be implemented. EngineQuery getAncestorEngineQuery()
OR
term.UnimplementedException
-
supportsAncestorEngineQuery()
is false
optional
- This method must be implemented if
supportsAncestorEngineQuery()
is true.
void matchAnyAncestorEngine(boolean match)
match
- true
to match engine with any ancestor,
false
to match root enginesmandatory
- This method must be implemented. void clearAncestorEngineTerms()
mandatory
- This method must be implemented. void matchDescendantEngineId(Id engineId, boolean match)
Id
for this query to match engines that
have the specified engine as a descendant.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 clearDescendantEngineIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantEngineQuery()
EngineQuery
is available. true
if an engine query is available,
false
otherwisemandatory
- This method must be implemented. EngineQuery getDescendantEngineQuery()
OR
term.UnimplementedException
-
supportsDescendantEngineQuery()
is false
optional
- This method must be implemented if
supportsDescendantEngineQuery()
is true.
void matchAnyDescendantEngine(boolean match)
match
- true
to match engine with any descendant,
false
to match leaf enginesmandatory
- This method must be implemented. void clearDescendantEngineTerms()
mandatory
- This method must be implemented. EngineQueryRecord getEngineQueryRecord(Type engineRecordType) throws OperationFailedException
Engine
record Type.
Multiple record retrievals produce
a nested boolean OR
term.engineRecordType
- an engine record typeNullArgumentException
- engineRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(engineRecordType)
is false
mandatory
- This method must be implemented.