public interface RelationshipQuery extends OsidRelationshipQuery
This is the query for searching relationships. 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 |
clearDestinationIdTerms()
Clears the other peer
Id terms. |
void |
clearFamilyIdTerms()
Clears the family
Id terms. |
void |
clearFamilyTerms()
Clears the family terms.
|
void |
clearSamePeerIdTerms()
Clears the same peer
Id terms. |
void |
clearSourceIdTerms()
Clears the peer
Id terms. |
FamilyQuery |
getFamilyQuery()
Gets the query for a family.
|
RelationshipQueryRecord |
getRelationshipQueryRecord(Type relationshipRecordType)
Gets the relationship query record corresponding to the given
Relationship record Type. |
void |
matchDestinationId(Id peer,
boolean match)
Matches the other relationship peer.
|
void |
matchFamilyId(Id familyId,
boolean match)
Sets the family
Id for this query. |
void |
matchSamePeerId(boolean match)
Matches circular relationships to the same peer.
|
void |
matchSourceId(Id peer,
boolean match)
Matches a relationship peer.
|
boolean |
supportsFamilyQuery()
Tests if a
FamilyQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchSourceId(Id peer, boolean match)
peer
- peer Id
to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- peer
is
null
mandatory
- This method must be implemented. void clearSourceIdTerms()
Id
terms.mandatory
- This method must be implemented. void matchDestinationId(Id peer, boolean match)
peer
- peer Id
to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- peer
is
null
mandatory
- This method must be implemented. void clearDestinationIdTerms()
Id
terms.mandatory
- This method must be implemented. void matchSamePeerId(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearSamePeerIdTerms()
Id
terms.mandatory
- This method must be implemented. void matchFamilyId(Id familyId, boolean match)
Id
for this query.familyId
- a family Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- familyId
is
null
mandatory
- This method must be implemented. void clearFamilyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsFamilyQuery()
FamilyQuery
is available. true
if a family query is available,
false
otherwisemandatory
- This method must be implemented. FamilyQuery getFamilyQuery()
OR
term.UnimplementedException
- supportsFamilyQuery()
is false
optional
- This method must be implemented if
supportsFamilyQuery()
is true.
void clearFamilyTerms()
mandatory
- This method must be implemented. RelationshipQueryRecord getRelationshipQueryRecord(Type relationshipRecordType) throws OperationFailedException, PermissionDeniedException
Relationship
record Type.
Multiple record
retrievals produce a nested OR
term.relationshipRecordType
- a relationship record typeNullArgumentException
- relationshipRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(relationshipRecordType)
is false
mandatory
- This method must be implemented.