org.osid.relationship

Interface FamilyQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface FamilyQuery
extends OsidCatalogQuery

This is the query interface for searching for families. Each method 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	clearAncestorFamilyIdTerms() Clears the ancestor family Id terms.
void	clearAncestorFamilyTerms() Clears the ancestor family terms.
void	clearDescendantFamilyIdTerms() Clears the descendant family Id terms.
void	clearDescendantFamilyTerms() Clears the descendant family terms.
void	clearRelationshipIdTerms() Clears the relationship Id terms.
void	clearRelationshipTerms() Clears the relationship terms.
FamilyQuery	getAncestorFamilyQuery() Gets the query interface for a family.
FamilyQuery	getDescendantFamilyQuery() Gets the query interface for a family.
FamilyQueryRecord	getFamilyQueryRecord(Type familyRecordType) Gets the family query record corresponding to the given Family record Type.
RelationshipQuery	getRelationshipQuery() Gets the query interface for a relationship.
void	matchAncestorFamilyId(Id familyId, boolean match) Sets the family Id for this query to match families that have the specified family as an ancestor.
void	matchAnyAncestorFamily(boolean match) Matches families with any ancestor.
void	matchAnyDescendantFamily(boolean match) Matches families with any decendant.
void	matchAnyRelationship(boolean match) Matches families with any relationship.
void	matchDescendantFamilyId(Id familyId, boolean match) Sets the family Id for this query to match families that have the specified family as a descednant.
void	matchRelationshipId(Id relationshipId, boolean match) Matches a relationship Id.
boolean	supportsAncestorFamilyQuery() Tests if a FamilyQuery is available.
boolean	supportsDescendantFamilyQuery() Tests if a FamilyQuery is available.
boolean	supportsRelationshipQuery() Tests if a relationship query is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipPeerIdTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, 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.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchRelationshipId

void matchRelationshipId(Id relationshipId,
                       boolean match)

Matches a relationship Id.

Specified by:

matchRelationshipId in interface OsidObjectQuery

Parameters:

relationshipId - a relationship Id

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

Throws:

NullArgumentException - relationshipId is null

Compliance:

mandatory - This method must be implemented.

clearRelationshipIdTerms

void clearRelationshipIdTerms()

Clears the relationship Id terms.

Specified by:

clearRelationshipIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsRelationshipQuery

boolean supportsRelationshipQuery()

Tests if a relationship query is available.

Specified by:

supportsRelationshipQuery in interface OsidObjectQuery

Returns:

true if a relationship query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRelationshipQuery

RelationshipQuery getRelationshipQuery()

Gets the query interface for a relationship.

Specified by:

getRelationshipQuery in interface OsidObjectQuery

Returns:

the relationship query

Throws:

UnimplementedException - supportsRelationshipQuery() is false

Compliance:

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

matchAnyRelationship

void matchAnyRelationship(boolean match)

Matches families with any relationship.

Specified by:

matchAnyRelationship in interface OsidObjectQuery

Parameters:

match - true to match families with any relationship, false to match families with no relationship

Compliance:

mandatory - This method must be implemented.

clearRelationshipTerms

void clearRelationshipTerms()

Clears the relationship terms.

Specified by:

clearRelationshipTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchAncestorFamilyId

void matchAncestorFamilyId(Id familyId,
                         boolean match)

Sets the family Id for this query to match families that have the specified family as an ancestor.

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.

clearAncestorFamilyIdTerms

void clearAncestorFamilyIdTerms()

Clears the ancestor family Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorFamilyQuery

boolean supportsAncestorFamilyQuery()

Tests if a FamilyQuery is available.

Returns:

true if a family query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorFamilyQuery

FamilyQuery getAncestorFamilyQuery()

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

Returns:

the family query

Throws:

UnimplementedException - supportsAncestorFamilyQuery() is false

Compliance:

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

matchAnyAncestorFamily

void matchAnyAncestorFamily(boolean match)

Matches families with any ancestor.

Parameters:

match - true to match families with any ancestor, false to match root families

Compliance:

mandatory - This method must be implemented.

clearAncestorFamilyTerms

void clearAncestorFamilyTerms()

Clears the ancestor family terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantFamilyId

void matchDescendantFamilyId(Id familyId,
                           boolean match)

Sets the family Id for this query to match families that have the specified family as a descednant.

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.

clearDescendantFamilyIdTerms

void clearDescendantFamilyIdTerms()

Clears the descendant family Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantFamilyQuery

boolean supportsDescendantFamilyQuery()

Tests if a FamilyQuery is available.

Returns:

true if a family query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantFamilyQuery

FamilyQuery getDescendantFamilyQuery()

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

Returns:

the family query

Throws:

UnimplementedException - supportsDescendantFamilyQuery() is false

Compliance:

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

matchAnyDescendantFamily

void matchAnyDescendantFamily(boolean match)

Matches families with any decendant.

Parameters:

match - true to match families with any decendants, false to match leaf families

Compliance:

mandatory - This method must be implemented.

clearDescendantFamilyTerms

void clearDescendantFamilyTerms()

Clears the descendant family terms.

Compliance:

mandatory - This method must be implemented.

getFamilyQueryRecord

FamilyQueryRecord getFamilyQueryRecord(Type familyRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the family query record corresponding to the given Family record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

familyRecordType - a family record type

Returns:

the family query record

Throws:

NullArgumentException - familyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(familyRecordType) is false

Compliance:

mandatory - This method must be implemented.