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.
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 |
clearConferralIdTerms()
Clears the conferral
Id terms. |
void |
clearConferralTerms()
Clears the conferral terms.
|
void |
clearDateTerms()
Clears the date 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. |
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 |
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 |
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 |
supportsTimePeriodQuery()
Tests if a
TimePeriodQuery 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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
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 matchAnyAward(boolean match)
match
- true
to match convocations with any
award, false
to match convocations with no
awardsmandatory
- This method must be implemented. void clearAwardTerms()
mandatory
- This method must be implemented. void matchDate(DateTime from, DateTime to, boolean match)
from
- starting dateto
- ending datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyDate(boolean match)
match
- true
to match convocations with any date,
false
to match convocations with no datemandatory
- This method must be implemented. void clearDateTerms()
mandatory
- This method must be implemented. void matchTimePeriodId(Id timePeriodId, boolean match)
Id.
timePeriodId
- a time period Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- timePeriodId
is
null
mandatory
- This method must be implemented. void clearTimePeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTimePeriodQuery()
TimePeriodQuery
is available. true
if a time period query is available,
false
otherwisemandatory
- This method must be implemented. TimePeriodQuery getTimePeriodQuery()
OR
term.UnimplementedException
-
supportsTimePeriodQuery()
is false
optional
- This method must be implemented if
supportsTimePeriodQuery()
is true.
void matchAnyTimePeriod(boolean match)
match
- true
to match convocations with any time
period, false
to match convocations with no
time periodmandatory
- This method must be implemented. void clearTimePeriodTerms()
mandatory
- This method must be implemented. void matchConferralId(Id conferralId, boolean match)
Id
for this query.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 convocations with any
conferral, false
to match convocations 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 convocations
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. ConvocationQueryRecord getConvocationQueryRecord(Type convocationRecordType) throws OperationFailedException
Convocation
record Type.
Multiple record
retrievals produce a nested OR
term.convocationRecordType
- a convocation record typeNullArgumentException
- convocationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(convocationRecordType)
is false
mandatory
- This method must be implemented.