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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested boolean OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsRelationshipQuery()} is {@code 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 {@code supportsAncestorFamilyQuery()} is {@code 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 {@code supportsDescendantFamilyQuery()} is {@code 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.