public interface NodeQuery extends OsidObjectQuery
This is the query for searching nodes. 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 |
clearEdgeIdTerms()
Clears the edge
Id terms. |
void |
clearEdgeTerms()
Clears the edge terms.
|
void |
clearGraphIdTerms()
Clears the graph
Id terms. |
void |
clearGraphTerms()
Clears the graph terms.
|
EdgeQuery |
getEdgeQuery()
Gets the query for an edge.
|
GraphQuery |
getGraphQuery()
Gets the query for a graph.
|
NodeQueryRecord |
getNodeQueryRecord(Type nodeRecordType)
Gets the node record query corresponding to the given
Node
record Type. |
void |
matchEdgeId(Id edgeId,
boolean match)
Sets the edge
Id for this query to match nodes that
have a related edge. |
void |
matchGraphId(Id graphId,
boolean match)
Sets the graph
Id for this query. |
boolean |
supportsEdgeQuery()
Tests if a
EdgeQuery is available. |
boolean |
supportsGraphQuery()
Tests if a
GraphQuery 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
void matchEdgeId(Id edgeId, boolean match)
Id
for this query to match nodes that
have a related edge.edgeId
- an edge Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- edgeId
is
null
mandatory
- This method must be implemented. void clearEdgeIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEdgeQuery()
EdgeQuery
is available. true
if an edge query is available,
false
otherwisemandatory
- This method must be implemented. EdgeQuery getEdgeQuery()
OR
term.UnimplementedException
- supportsEdgeQuery()
is false
optional
- This method must be implemented if
supportsEdgeQuery()
is true.
void clearEdgeTerms()
mandatory
- This method must be implemented. void matchGraphId(Id graphId, boolean match)
Id
for this query.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
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. NodeQueryRecord getNodeQueryRecord(Type nodeRecordType) throws OperationFailedException
Node
record Type.
Multiple record retrievals produce
a nested OR
term.nodeRecordType
- a node record typeNullArgumentException
- nodeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(nodeRecordType)
is false
mandatory
- This method must be implemented.