org.osid.recognition

Interface ConferralQuery

All Superinterfaces:

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

public interface ConferralQuery
extends OsidRelationshipQuery

This is the query for searching conferrals. 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	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	clearConvocationIdTerms() Clears the convocaton Id terms.
void	clearConvocationTerms() Clears the convocaton terms.
void	clearRecipientIdTerms() Clears the resource Id terms.
void	clearRecipientTerms() Clears the resource terms.
void	clearReferenceIdTerms() Clears the reference Id terms.
AcademyQuery	getAcademyQuery() Gets the query for an academy query.
AwardQuery	getAwardQuery() Gets the query for an award query.
ConferralQueryRecord	getConferralQueryRecord(Type conferralRecordType) Gets the conferral query record corresponding to the given Conferral record Type.
ConvocationQuery	getConvocationQuery() Gets the query for a convocaton query.
ResourceQuery	getRecipientQuery() Gets the query for a resource query.
void	matchAcademyId(Id academyId, boolean match) Sets the award Id for this query to match conferrals assigned to academies.
void	matchAnyConvocation(boolean match) Matches any convocaton.
void	matchAnyReferenceId(boolean match) Matches any reference.
void	matchAwardId(Id awardId, boolean match) Sets an award Id.
void	matchConvocationId(Id convocationId, boolean match) Sets a convocaton Id.
void	matchRecipientId(Id resourceId, boolean match) Sets a resource Id.
void	matchReferenceId(Id referenceId, boolean match) Sets a reference Id.
boolean	supportsAcademyQuery() Tests if an AcademyQuery is available.
boolean	supportsAwardQuery() Tests if an AwardQuery is available.
boolean	supportsConvocationQuery() Tests if a ConvocationQuery is available.
boolean	supportsRecipientQuery() Tests if a ResourceQuery 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

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 supportsAwardQuery() is true.

clearAwardTerms

void clearAwardTerms()

Clears the award terms.

Compliance:

mandatory - This method must be implemented.

matchRecipientId

void matchRecipientId(Id resourceId,
                    boolean match)

Sets a resource Id.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearRecipientIdTerms

void clearRecipientIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRecipientQuery

boolean supportsRecipientQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRecipientQuery

ResourceQuery getRecipientQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsRecipientQuery() is false

Compliance:

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

clearRecipientTerms

void clearRecipientTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchReferenceId

void matchReferenceId(Id referenceId,
                    boolean match)

Sets a reference Id.

Parameters:

referenceId - a reference Id

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

Throws:

NullArgumentException - referenceId is null

Compliance:

mandatory - This method must be implemented.

matchAnyReferenceId

void matchAnyReferenceId(boolean match)

Matches any reference.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearReferenceIdTerms

void clearReferenceIdTerms()

Clears the reference Id 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 for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearConvocationTerms

void clearConvocationTerms()

Clears the convocaton terms.

Compliance:

mandatory - This method must be implemented.

matchAcademyId

void matchAcademyId(Id academyId,
                  boolean match)

Sets the award Id for this query to match conferrals 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 supportsAcademyQuery() is true.

clearAcademyTerms

void clearAcademyTerms()

Clears the academy terms.

Compliance:

mandatory - This method must be implemented.

getConferralQueryRecord

ConferralQueryRecord getConferralQueryRecord(Type conferralRecordType)
                                             throws OperationFailedException

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

Parameters:

conferralRecordType - a conferral record type

Returns:

the conferral query record

Throws:

NullArgumentException - conferralRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(conferralRecordType) is false

Compliance:

mandatory - This method must be implemented.