org.osid.relationship

Interface RelationshipQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchSourceId

void matchSourceId(Id peer,
                 boolean match)

Matches a relationship peer.

Parameters:

peer - peer Id to match

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - peer is null

Compliance:

mandatory - This method must be implemented.

clearSourceIdTerms

void clearSourceIdTerms()

Clears the peer Id terms.

Compliance:

mandatory - This method must be implemented.

matchDestinationId

void matchDestinationId(Id peer,
                      boolean match)

Matches the other relationship peer.

Parameters:

peer - peer Id to match

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - peer is null

Compliance:

mandatory - This method must be implemented.

clearDestinationIdTerms

void clearDestinationIdTerms()

Clears the other peer Id terms.

Compliance:

mandatory - This method must be implemented.

matchSamePeerId

void matchSamePeerId(boolean match)

Matches circular relationships to the same peer.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearSamePeerIdTerms

void clearSamePeerIdTerms()

Clears the same peer Id terms.

Compliance:

mandatory - This method must be implemented.

matchFamilyId

void matchFamilyId(Id familyId,
                 boolean match)

Sets the family Id for this query.

Parameters:

familyId - a family Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - familyId is null

Compliance:

mandatory - This method must be implemented.

clearFamilyIdTerms

void clearFamilyIdTerms()

Clears the family Id terms.

Compliance:

mandatory - This method must be implemented.

supportsFamilyQuery

boolean supportsFamilyQuery()

Tests if a FamilyQuery is available.

Returns:

true if a family query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFamilyQuery

FamilyQuery getFamilyQuery()

Gets the query for a family. Multiple retrievals produce a nested OR term.

Returns:

the family query

Throws:

UnimplementedException - supportsFamilyQuery() is false

Compliance:

optional - This method must be implemented if supportsFamilyQuery() is true.

clearFamilyTerms

void clearFamilyTerms()

Clears the family terms.

Compliance:

mandatory - This method must be implemented.

getRelationshipQueryRecord

RelationshipQueryRecord getRelationshipQueryRecord(Type relationshipRecordType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets the relationship query record corresponding to the given Relationship record Type. Multiple record retrievals produce a nested OR term.

Parameters:

relationshipRecordType - a relationship record type

Returns:

the relationship query record

Throws:

NullArgumentException - relationshipRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.