public interface EdgeEnablerQuery extends OsidEnablerQuery
This is the query for searching edge 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 |
clearGraphIdTerms()
Clears the graph
Id query terms. |
void |
clearGraphTerms()
Clears the graph query terms.
|
void |
clearRuledEdgeIdTerms()
Clears the edge
Id query terms. |
void |
clearRuledEdgeTerms()
Clears the edge query terms.
|
EdgeEnablerQueryRecord |
getEdgeEnablerQueryRecord(Type edgeEnablerRecordType)
Gets the edge enabler query record corresponding to the given
EdgeEnabler record Type. |
GraphQuery |
getGraphQuery()
Gets the query for a graph.
|
EdgeQuery |
getRuledEdgeQuery()
Gets the query for an edge.
|
void |
matchAnyRuledEdge(boolean match)
Matches enablers mapped to any edge.
|
void |
matchGraphId(Id graphId,
boolean match)
Matches enablers mapped to the graph.
|
void |
matchRuledEdgeId(Id edgeId,
boolean match)
Matches enablers mapped to the edge.
|
boolean |
supportsGraphQuery()
Tests if a
GraphQuery is available. |
boolean |
supportsRuledEdgeQuery()
Tests if an
EdgeQuery 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 matchRuledEdgeId(Id edgeId, boolean match)
edgeId
- the edge Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- edgeId
is
null
mandatory
- This method must be implemented. void clearRuledEdgeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledEdgeQuery()
EdgeQuery
is available. true
if an edge query is available,
false
otherwisemandatory
- This method must be implemented. EdgeQuery getRuledEdgeQuery()
OR
term.UnimplementedException
-
supportsRuledEdgeQuery()
is false
optional
- This method must be implemented if
supportsRuledEdgeQuery()
is true.
void matchAnyRuledEdge(boolean match)
match
- true
for enablers mapped to any edge,
false
to match enablers mapped to no edgemandatory
- This method must be implemented. void clearRuledEdgeTerms()
mandatory
- This method must be implemented. void matchGraphId(Id graphId, boolean match)
graphId
- the graph Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- graphId
is
null
mandatory
- This method must be implemented. void clearGraphIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsGraphQuery()
GraphQuery
is available. true
if a graph query is available,
false
otherwisemandatory
- This method must be implemented. GraphQuery getGraphQuery()
OR
term.UnimplementedException
- supportsGraphQuery()
is false
optional
- This method must be implemented if
supportsGraphQuery()
is true.
void clearGraphTerms()
mandatory
- This method must be implemented. EdgeEnablerQueryRecord getEdgeEnablerQueryRecord(Type edgeEnablerRecordType) throws OperationFailedException
EdgeEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.edgeEnablerRecordType
- an edge enabler record typeNullArgumentException
- edgeEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(edgeEnablerRecordType)
is false
mandatory
- This method must be implemented.