org.osid.recognition

Interface AcademyQuery

All Superinterfaces:

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

public interface AcademyQuery
extends OsidCatalogQuery

This is the query for searching for academies. 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	clearAncestorAcademyIdTerms() Clears the ancestor academy Id terms.
void	clearAncestorAcademyTerms() Clears the ancestor academy terms.
void	clearAwardIdTerms() Clears the award Id terms.
void	clearAwardTerms() Clears the award terms.
void	clearConferralIdTerms() Clears the conferral Id terms.
void	clearConferralTerms() Clears the conferral terms.
void	clearConvocationIdTerms() Clears the convocaton Id terms.
void	clearConvocationTerms() Clears the convocaton terms.
void	clearDescendantAcademyIdTerms() Clears the descendant academy Id terms.
void	clearDescendantAcademyTerms() Clears the descendant academy terms.
AcademyQueryRecord	getAcademyQueryRecord(Type academyRecordType) Gets the query record corresponding to the given Academy record Type.
AcademyQuery	getAncestorAcademyQuery() Gets the query for an academy.
AwardQuery	getAwardQuery() Gets the query for an award query.
ConferralQuery	getConferralQuery() Gets the query for an conferral.
ConvocationQuery	getConvocationQuery() Gets the query for a convocaton query.
AcademyQuery	getDescendantAcademyQuery() Gets the query for an academy.
void	matchAncestorAcademyId(Id academyId, boolean match) Sets the academy Id for this query to match academies that have the specified academy as an ancestor.
void	matchAnyAncestorAcademy(boolean match) Matches academies with any ancestor.
void	matchAnyAward(boolean match) Matches academies with any award.
void	matchAnyConferral(boolean match) Matches academies with any conferral.
void	matchAnyConvocation(boolean match) Matches any convocaton.
void	matchAnyDescendantAcademy(boolean match) Matches academies with any descendant.
void	matchAwardId(Id awardId, boolean match) Sets the award Id for this query to match conferrals assigned to awards.
void	matchConferralId(Id conferralId, boolean match) Sets the conferral Id for this query to match conferrals assigned to academies.
void	matchConvocationId(Id convocationId, boolean match) Sets a convocaton Id.
void	matchDescendantAcademyId(Id academyId, boolean match) Sets the academy Id for this query to match academies that have the specified academy as a descendant.
boolean	supportsAncestorAcademyQuery() Tests if an AcademyQuery is available.
boolean	supportsAwardQuery() Tests if an AwardQuery is available.
boolean	supportsConferralQuery() Tests if a conferral query is available.
boolean	supportsConvocationQuery() Tests if a ConvocationQuery is available.
boolean	supportsDescendantAcademyQuery() Tests if an AcademyQuery is available.

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.OsidSourceableQuery

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

Method Detail

matchConferralId

void matchConferralId(Id conferralId,
                    boolean match)

Sets the conferral Id for this query to match conferrals assigned to academies.

Parameters:

conferralId - a conferral Id

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

Throws:

NullArgumentException - conferralId is null

Compliance:

mandatory - This method must be implemented.

clearConferralIdTerms

void clearConferralIdTerms()

Clears the conferral Id terms.

Compliance:

mandatory - This method must be implemented.

supportsConferralQuery

boolean supportsConferralQuery()

Tests if a conferral query is available.

Returns:

true if a conferral query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getConferralQuery

ConferralQuery getConferralQuery()

Gets the query for an conferral.

Returns:

the conferral query

Throws:

UnimplementedException - supportsConferralQuery() is false

Compliance:

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

matchAnyConferral

void matchAnyConferral(boolean match)

Matches academies with any conferral.

Parameters:

match - true to match academies with any conferral, false to match academies with no conferrals

Compliance:

mandatory - This method must be implemented.

clearConferralTerms

void clearConferralTerms()

Clears the conferral terms.

Compliance:

mandatory - This method must be implemented.

matchAwardId

void matchAwardId(Id awardId,
                boolean match)

Sets the award Id for this query to match conferrals assigned to awards.

Parameters:

awardId - an award Id

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

Throws:

NullArgumentException - awardId is null

Compliance:

mandatory - This method must be implemented.

clearAwardIdTerms

void clearAwardIdTerms()

Clears the award Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAwardQuery

boolean supportsAwardQuery()

Tests if an AwardQuery is available.

Returns:

true if an award query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAwardQuery

AwardQuery getAwardQuery()

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

Returns:

the award query

Throws:

UnimplementedException - supportsAwardQuery() is false

Compliance:

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

matchAnyAward

void matchAnyAward(boolean match)

Matches academies with any award.

Parameters:

match - true to match academies with any award, false to match academies with no awards

Compliance:

mandatory - This method must be implemented.

clearAwardTerms

void clearAwardTerms()

Clears the award terms.

Compliance:

mandatory - This method must be implemented.

matchConvocationId

void matchConvocationId(Id convocationId,
                      boolean match)

Sets a convocaton Id.

Parameters:

convocationId - a convocaton Id

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

Throws:

NullArgumentException - convocationId is null

Compliance:

mandatory - This method must be implemented.

clearConvocationIdTerms

void clearConvocationIdTerms()

Clears the convocaton Id terms.

Compliance:

mandatory - This method must be implemented.

supportsConvocationQuery

boolean supportsConvocationQuery()

Tests if a ConvocationQuery is available.

Returns:

true if a convocaton query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getConvocationQuery

ConvocationQuery getConvocationQuery()

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

Returns:

the convocaton query

Throws:

UnimplementedException - supportsConvocationQuery() is false

Compliance:

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

matchAnyConvocation

void matchAnyConvocation(boolean match)

Matches any convocaton.

Parameters:

match - true to match academies with any convocation, false to match academies with no convocations

Compliance:

mandatory - This method must be implemented.

clearConvocationTerms

void clearConvocationTerms()

Clears the convocaton terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAcademyId

void matchAncestorAcademyId(Id academyId,
                          boolean match)

Sets the academy Id for this query to match academies that have the specified academy as an ancestor.

Parameters:

academyId - an academy Id

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

Throws:

NullArgumentException - academyId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorAcademyIdTerms

void clearAncestorAcademyIdTerms()

Clears the ancestor academy Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAcademyQuery

boolean supportsAncestorAcademyQuery()

Tests if an AcademyQuery is available.

Returns:

true if an academy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAcademyQuery

AcademyQuery getAncestorAcademyQuery()

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

Returns:

the academy query

Throws:

UnimplementedException - supportsAncestorAcademyQuery() is false

Compliance:

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

matchAnyAncestorAcademy

void matchAnyAncestorAcademy(boolean match)

Matches academies with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorAcademyTerms

void clearAncestorAcademyTerms()

Clears the ancestor academy terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAcademyId

void matchDescendantAcademyId(Id academyId,
                            boolean match)

Sets the academy Id for this query to match academies that have the specified academy as a descendant.

Parameters:

academyId - an academy Id

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

Throws:

NullArgumentException - academyId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantAcademyIdTerms

void clearDescendantAcademyIdTerms()

Clears the descendant academy Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAcademyQuery

boolean supportsDescendantAcademyQuery()

Tests if an AcademyQuery is available.

Returns:

true if an academy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAcademyQuery

AcademyQuery getDescendantAcademyQuery()

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

Returns:

the academy query

Throws:

UnimplementedException - supportsDescendantAcademyQuery() is false

Compliance:

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

matchAnyDescendantAcademy

void matchAnyDescendantAcademy(boolean match)

Matches academies with any descendant.

Parameters:

match - true to match academies with any descendant, false to match leaf academies

Compliance:

mandatory - This method must be implemented.

clearDescendantAcademyTerms

void clearDescendantAcademyTerms()

Clears the descendant academy terms.

Compliance:

mandatory - This method must be implemented.

getAcademyQueryRecord

AcademyQueryRecord getAcademyQueryRecord(Type academyRecordType)
                                         throws OperationFailedException

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

Parameters:

academyRecordType - an academy record type

Returns:

the academy query record

Throws:

NullArgumentException - academyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(academyRecordType) is false

Compliance:

mandatory - This method must be implemented.