org.osid.recognition

Interface AwardQuery

All Superinterfaces:

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

public interface AwardQuery
extends OsidObjectQuery

This is the query for searching for awards. 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	clearConferralIdTerms() Clears the conferral Id terms.
void	clearConferralTerms() Clears the conferral terms.
AcademyQuery	getAcademyQuery() Gets the query for an academy query.
AwardQueryRecord	getAwardQueryRecord(Type awardRecordType) Gets the award query record corresponding to the given Award record Type.
ConferralQuery	getConferralQuery() Gets the query for an award.
void	matchAcademyId(Id academyId, boolean match) Sets the award Id for this query to match conferrals assigned to academies.
void	matchAnyConferral(boolean match) Matches awards with any conferral.
void	matchConferralId(Id conferralId, boolean match) Sets the conferral Id for this query to match conferrals assigned to awards.
boolean	supportsAcademyQuery() Tests if an AcademyQuery is available.
boolean	supportsConferralQuery() Tests if a conferral query 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

Method Detail

matchConferralId

void matchConferralId(Id conferralId,
                    boolean match)

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

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

matchAnyConferral

void matchAnyConferral(boolean match)

Matches awards with any conferral.

Parameters:

match - true to match awards with any conferral, false to match awards 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 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.

getAwardQueryRecord

AwardQueryRecord getAwardQueryRecord(Type awardRecordType)
                                     throws OperationFailedException

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

Parameters:

awardRecordType - an award record type

Returns:

the award query record

Throws:

NullArgumentException - awardRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardRecordType) is false

Compliance:

mandatory - This method must be implemented.