Interface ConvocationQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface ConvocationQuery
extends OsidGovernatorQuery

This is the query for searching convocations. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Like all OsidQueries, ConvocationQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
void	clearAcademyIdTerms()	Clears the academy Id terms.
void	clearAcademyTerms()	Clears the 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	clearDateTerms()	Clears the date terms.
void	clearSponsorIdTerms()	Clears the sponsor Id query terms.
void	clearSponsorTerms()	Clears the sponsor query terms.
void	clearTimePeriodIdTerms()	Clears the time period Id terms.
void	clearTimePeriodTerms()	Clears the time period terms.
AcademyQuery	getAcademyQuery()	Gets the query for an academy query.
AwardQuery	getAwardQuery()	Gets the query for an award query.
ConferralQuery	getConferralQuery()	Gets the query for an award.
ConvocationQueryRecord	getConvocationQueryRecord(Type convocationRecordType)	Gets the convocation query record corresponding to the given Convocation record Type.
ResourceQuery	getSponsorQuery()	Gets the query for a sponsor.
TimePeriodQuery	getTimePeriodQuery()	Gets the query for a time period query.
void	matchAcademyId(Id academyId, boolean match)	Sets the award Id for this query to match convocations assigned to academies.
void	matchAnyAward(boolean match)	Matches convocations with any award.
void	matchAnyConferral(boolean match)	Matches convocations with any conferral.
void	matchAnyDate(boolean match)	Matches convocations with any date.
void	matchAnySponsor(boolean match)	Matches objects with any sponsor.
void	matchAnyTimePeriod(boolean match)	Matches any time period.
void	matchAwardId(Id awardId, boolean match)	Sets an award Id.
void	matchConferralId(Id conferralId, boolean match)	Sets the conferral Id for this query.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches the date between the given dates inclusive.
void	matchSponsorId(Id sponsorId, boolean match)	Sets a sponsor Id for this query.
void	matchTimePeriodId(Id timePeriodId, boolean match)	Sets a time period Id.
boolean	supportsAcademyQuery()	Tests if an AcademyQuery is available.
boolean	supportsAwardQuery()	Tests if an AwardQuery is available.
boolean	supportsConferralQuery()	Tests if a conferral query is available.
boolean	supportsSponsorQuery()	Tests if a ResourceQuery is available.
boolean	supportsTimePeriodQuery()	Tests if a TimePeriodQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

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

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidSourceableQuery

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

Method Details

matchSponsorId

void matchSponsorId(Id sponsorId,
 boolean match)

Sets a sponsor Id for this query.

Parameters:

sponsorId - a sponsor Id

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

Throws:

NullArgumentException - sponsorId is null

Compliance:

mandatory - This method must be implemented.

clearSponsorIdTerms

void clearSponsorIdTerms()

Clears the sponsor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSponsorQuery

boolean supportsSponsorQuery()

Tests if a ResourceQuery is available.

Returns:

true if a sponsor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSponsorQuery

ResourceQuery getSponsorQuery()

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

Returns:

the sponsor query

Throws:

UnimplementedException - supportsSponsorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSponsorQuery()} is {@code true}.

matchAnySponsor

void matchAnySponsor(boolean match)

Matches objects with any sponsor.

Parameters:

match - true to match objects with any sponsor, false to match objects with no sponsor

Compliance:

mandatory - This method must be implemented.

clearSponsorTerms

void clearSponsorTerms()

Clears the sponsor query terms.

Compliance:

mandatory - This method must be implemented.

matchAwardId

void matchAwardId(Id awardId,
 boolean match)

Sets an award Id.

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 {@code supportsAwardQuery()} is {@code true}.

matchAnyAward

void matchAnyAward(boolean match)

Matches convocations with any award.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAwardTerms

void clearAwardTerms()

Clears the award terms.

Compliance:

mandatory - This method must be implemented.

matchDate

void matchDate(DateTime from,
 DateTime to,
 boolean match)

Matches the date between the given dates inclusive.

Parameters:

from - starting date

to - ending date

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyDate

void matchAnyDate(boolean match)

Matches convocations with any date.

Parameters:

match - true to match convocations with any date, false to match convocations with no date

Compliance:

mandatory - This method must be implemented.

clearDateTerms

void clearDateTerms()

Clears the date terms.

Compliance:

mandatory - This method must be implemented.

matchTimePeriodId

void matchTimePeriodId(Id timePeriodId,
 boolean match)

Sets a time period Id.

Parameters:

timePeriodId - a time period Id

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

Throws:

NullArgumentException - timePeriodId is null

Compliance:

mandatory - This method must be implemented.

clearTimePeriodIdTerms

void clearTimePeriodIdTerms()

Clears the time period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTimePeriodQuery

boolean supportsTimePeriodQuery()

Tests if a TimePeriodQuery is available.

Returns:

true if a time period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimePeriodQuery

TimePeriodQuery getTimePeriodQuery()

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

Returns:

the time period query

Throws:

UnimplementedException - supportsTimePeriodQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsTimePeriodQuery()} is {@code true}.

matchAnyTimePeriod

void matchAnyTimePeriod(boolean match)

Matches any time period.

Parameters:

match - true to match convocations with any time period, false to match convocations with no time period

Compliance:

mandatory - This method must be implemented.

clearTimePeriodTerms

void clearTimePeriodTerms()

Clears the time period terms.

Compliance:

mandatory - This method must be implemented.

matchConferralId

void matchConferralId(Id conferralId,
 boolean match)

Sets the conferral Id for this query.

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

Returns:

the conferral query

Throws:

UnimplementedException - supportsConferralQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsConferralQuery()} is {@code true}.

matchAnyConferral

void matchAnyConferral(boolean match)

Matches convocations with any conferral.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearConferralTerms

void clearConferralTerms()

Clears the conferral terms.

Compliance:

mandatory - This method must be implemented.

matchAcademyId

void matchAcademyId(Id academyId,
 boolean match)

Sets the award Id for this query to match convocations assigned to academies.

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.

clearAcademyIdTerms

void clearAcademyIdTerms()

Clears the academy Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAcademyQuery

boolean supportsAcademyQuery()

Tests if an AcademyQuery is available.

Returns:

true if an academy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAcademyQuery

AcademyQuery getAcademyQuery()

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

Returns:

the academy query

Throws:

UnimplementedException - supportsAcademyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAcademyQuery()} is {@code true}.

clearAcademyTerms

void clearAcademyTerms()

Clears the academy terms.

Compliance:

mandatory - This method must be implemented.

getConvocationQueryRecord

ConvocationQueryRecord getConvocationQueryRecord(Type convocationRecordType)
                                          throws OperationFailedException

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

Parameters:

convocationRecordType - a convocation record type

Returns:

the convocation query record

Throws:

NullArgumentException - convocationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationRecordType) is false

Compliance:

mandatory - This method must be implemented.