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.
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchAwardId(Id awardId, boolean match)
Id.
awardId
- an award Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- awardId
is
null
mandatory
- This method must be implemented. void clearAwardIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAwardQuery()
AwardQuery
is available. true
if an award query is available,
false
otherwisemandatory
- This method must be implemented. AwardQuery getAwardQuery()
OR
term.UnimplementedException
- supportsAwardQuery()
is false
optional
- This method must be implemented if
supportsAwardQuery()
is true.
void clearAwardTerms()
mandatory
- This method must be implemented. void matchRecipientId(Id resourceId, boolean match)
Id.
resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearRecipientIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRecipientQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getRecipientQuery()
OR
term.UnimplementedException
-
supportsRecipientQuery()
is false
optional
- This method must be implemented if
supportsRecipientQuery()
is true.
void clearRecipientTerms()
mandatory
- This method must be implemented. void matchReferenceId(Id referenceId, boolean match)
Id.
referenceId
- a reference Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- referenceId
is
null
mandatory
- This method must be implemented. void matchAnyReferenceId(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearReferenceIdTerms()
Id
terms.mandatory
- This method must be implemented. void matchConvocationId(Id convocationId, boolean match)
Id.
convocationId
- a convocaton Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- convocationId
is
null
mandatory
- This method must be implemented. void clearConvocationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsConvocationQuery()
ConvocationQuery
is available. true
if a convocaton query is available,
false
otherwisemandatory
- This method must be implemented. ConvocationQuery getConvocationQuery()
OR
term.UnimplementedException
-
supportsConvocationQuery()
is false
optional
- This method must be implemented if
supportsConvocationQuery()
is true.
void matchAnyConvocation(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearConvocationTerms()
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. ConferralQueryRecord getConferralQueryRecord(Type conferralRecordType) throws OperationFailedException
Conferral
record Type.
Multiple record
retrievals produce a nested OR
term.conferralRecordType
- a conferral record typeNullArgumentException
- conferralRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(conferralRecordType)
is false
mandatory
- This method must be implemented.