public interface AcademyQuery extends OsidCatalogQuery
This is the query for searching for academies. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorAcademyIdTerms()
Clears the ancestor academy
Id terms. |
void |
clearAncestorAcademyTerms()
Clears the ancestor 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 |
clearConvocationIdTerms()
Clears the convocaton
Id terms. |
void |
clearConvocationTerms()
Clears the convocaton terms.
|
void |
clearDescendantAcademyIdTerms()
Clears the descendant academy
Id terms. |
void |
clearDescendantAcademyTerms()
Clears the descendant academy terms.
|
AcademyQueryRecord |
getAcademyQueryRecord(Type academyRecordType)
Gets the query record corresponding to the given
Academy
record Type. |
AcademyQuery |
getAncestorAcademyQuery()
Gets the query for an academy.
|
AwardQuery |
getAwardQuery()
Gets the query for an award query.
|
ConferralQuery |
getConferralQuery()
Gets the query for an conferral.
|
ConvocationQuery |
getConvocationQuery()
Gets the query for a convocaton query.
|
AcademyQuery |
getDescendantAcademyQuery()
Gets the query for an academy.
|
void |
matchAncestorAcademyId(Id academyId,
boolean match)
Sets the academy
Id for this query to match academies
that have the specified academy as an ancestor. |
void |
matchAnyAncestorAcademy(boolean match)
Matches academies with any ancestor.
|
void |
matchAnyAward(boolean match)
Matches academies with any award.
|
void |
matchAnyConferral(boolean match)
Matches academies with any conferral.
|
void |
matchAnyConvocation(boolean match)
Matches any convocaton.
|
void |
matchAnyDescendantAcademy(boolean match)
Matches academies with any descendant.
|
void |
matchAwardId(Id awardId,
boolean match)
Sets the award
Id for this query to match conferrals
assigned to awards. |
void |
matchConferralId(Id conferralId,
boolean match)
Sets the conferral
Id for this query to match
conferrals assigned to academies. |
void |
matchConvocationId(Id convocationId,
boolean match)
Sets a convocaton
Id. |
void |
matchDescendantAcademyId(Id academyId,
boolean match)
Sets the academy
Id for this query to match academies
that have the specified academy as a descendant. |
boolean |
supportsAncestorAcademyQuery()
Tests if an
AcademyQuery is available. |
boolean |
supportsAwardQuery()
Tests if an
AwardQuery is available. |
boolean |
supportsConferralQuery()
Tests if a conferral query is available.
|
boolean |
supportsConvocationQuery()
Tests if a
ConvocationQuery is available. |
boolean |
supportsDescendantAcademyQuery()
Tests if an
AcademyQuery 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchConferralId(Id conferralId, boolean match)
Id
for this query to match
conferrals assigned to academies.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 academies with any
conferral, false
to match academies with no
conferralsmandatory
- This method must be implemented. void clearConferralTerms()
mandatory
- This method must be implemented. void matchAwardId(Id awardId, boolean match)
Id
for this query to match conferrals
assigned to awards.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 academies with any award,
false
to match academies with no awardsmandatory
- This method must be implemented. void clearAwardTerms()
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
to match academies with any
convocation, false
to match academies with no
convocationsmandatory
- This method must be implemented. void clearConvocationTerms()
mandatory
- This method must be implemented. void matchAncestorAcademyId(Id academyId, boolean match)
Id
for this query to match academies
that have the specified academy as an ancestor.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 clearAncestorAcademyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorAcademyQuery()
AcademyQuery
is available. true
if an academy query is available,
false
otherwisemandatory
- This method must be implemented. AcademyQuery getAncestorAcademyQuery()
OR
term.UnimplementedException
-
supportsAncestorAcademyQuery()
is false
optional
- This method must be implemented if
supportsAncestorAcademyQuery()
is true.
void matchAnyAncestorAcademy(boolean match)
match
- true
to match academies with any
ancestor, false
to match root academiesmandatory
- This method must be implemented. void clearAncestorAcademyTerms()
mandatory
- This method must be implemented. void matchDescendantAcademyId(Id academyId, boolean match)
Id
for this query to match academies
that have the specified academy as a descendant.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 clearDescendantAcademyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantAcademyQuery()
AcademyQuery
is available. true
if an academy query is available,
false
otherwisemandatory
- This method must be implemented. AcademyQuery getDescendantAcademyQuery()
OR
term.UnimplementedException
-
supportsDescendantAcademyQuery()
is false
optional
- This method must be implemented if
supportsDescendantAcademyQuery()
is true.
void matchAnyDescendantAcademy(boolean match)
match
- true
to match academies with any
descendant, false
to match leaf academiesmandatory
- This method must be implemented. void clearDescendantAcademyTerms()
mandatory
- This method must be implemented. AcademyQueryRecord getAcademyQueryRecord(Type academyRecordType) throws OperationFailedException
Academy
record Type.
Multiple record retrievals produce
a nested boolean OR
term.academyRecordType
- an academy record typeNullArgumentException
- academyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(academyRecordType)
is false
mandatory
- This method must be implemented.