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.
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.
|
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchConferralId(Id conferralId, boolean match)
Id
for this query to match
conferrals assigned to awards.conferralId
- a conferral Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- conferralId
is
null
mandatory
- This method must be implemented. void clearConferralIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsConferralQuery()
true
if a conferral query is available,
false
otherwisemandatory
- This method must be implemented. ConferralQuery getConferralQuery()
UnimplementedException
-
supportsConferralQuery()
is false
optional
- This method must be implemented if
supportsConferralQuery()
is true.
void matchAnyConferral(boolean match)
match
- true
to match awards with any conferral,
false
to match awards with no conferralsmandatory
- This method must be implemented. void clearConferralTerms()
mandatory
- This method must be implemented. void matchAcademyId(Id academyId, boolean match)
Id
for this query to match conferrals
assigned to academies.academyId
- an academy Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- academyId
is
null
mandatory
- This method must be implemented. void clearAcademyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAcademyQuery()
AcademyQuery
is available. true
if an academy query is available,
false
otherwisemandatory
- This method must be implemented. AcademyQuery getAcademyQuery()
OR
term.UnimplementedException
- supportsAcademyQuery()
is false
optional
- This method must be implemented if
supportsAcademyQuery()
is true.
void clearAcademyTerms()
mandatory
- This method must be implemented. AwardQueryRecord getAwardQueryRecord(Type awardRecordType) throws OperationFailedException
Award
record Type.
Multiple record retrievals produce
a nested boolean OR
term.awardRecordType
- an award record typeNullArgumentException
- awardRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardRecordType)
is false
mandatory
- This method must be implemented.