public interface CanonicalUnitQuery extends OsidObjectQuery, OsidOperableQuery
This is the query for searching canonical units. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearCatalogueIdTerms()
Clears all catalogue
Id terms. |
void |
clearCatalogueTerms()
Clears all catalogue terms.
|
void |
clearCodeTerms()
Clears all code terms.
|
void |
clearOfferedCyclicTimePeriodIdTerms()
Clears all offered cyclic time period
Id terms. |
void |
clearOfferedCyclicTimePeriodTerms()
Clears all cyclic time period terms.
|
void |
clearResultOptionIdTerms()
Clears the grade system
Id terms. |
void |
clearResultOptionTerms()
Clears the grading option terms.
|
void |
clearSponsorIdTerms()
Clears the sponsor
Id terms. |
void |
clearSponsorTerms()
Clears the sponsor terms.
|
void |
clearTitleTerms()
Clears all title terms.
|
CanonicalUnitQueryRecord |
getCanonicalUnitQueryRecord(Type canonicalUnitRecordType)
Gets the canonical unit query record corresponding to the given
CanonicalUnit record Type. |
CatalogueQuery |
getCatalogueQuery()
Gets the query for a catalogue query.
|
CyclicTimePeriodQuery |
getOfferedCyclicTimePeriodQuery()
Gets the query for a cyclic period query.
|
GradeSystemQuery |
getResultOptionQuery()
Gets the query for a grading option.
|
ResourceQuery |
getSponsorQuery()
Gets the query for a sponsor.
|
void |
matchAnyCode(boolean match)
Matches canonical units with any code.
|
void |
matchAnyOfferedCyclicTimePeriod(boolean match)
Matches canonicals that have any cyclic time period.
|
void |
matchAnyResultOption(boolean match)
Matches canonicals that have any grading option.
|
void |
matchAnySponsor(boolean match)
Matches canonicals that have any sponsor.
|
void |
matchAnyTitle(boolean match)
Matches canonical units with any title.
|
void |
matchCatalogueId(Id catalogueId,
boolean match)
Sets the catalogue
Id for this query to match canonical
units assigned to catalogues. |
void |
matchCode(java.lang.String code,
Type stringMatchType,
boolean match)
Matches a code.
|
void |
matchOfferedCyclicTimePeriodId(Id cyclicTimePeriodId,
boolean match)
Sets the cyclic time period
Id for this query. |
void |
matchResultOptionId(Id gradeSystemId,
boolean match)
Sets the grade system
Id for this query. |
void |
matchSponsorId(Id resourceId,
boolean match)
Sets the resource
Id for this query to match canonicals
that have a sponsor. |
void |
matchTitle(java.lang.String title,
Type stringMatchType,
boolean match)
Matches a title.
|
boolean |
supportsCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsOfferedCyclicTimePeriodQuery()
Tests if a
CyclicTimePeriodQuery is available. |
boolean |
supportsResultOptionQuery()
Tests if a
GradeSystemQuery is available. |
boolean |
supportsSponsorQuery()
Tests if a
ResourceQuery 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
void matchTitle(java.lang.String title, Type stringMatchType, boolean match)
title
- a titlestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- title
is not
of stringMatchType
NullArgumentException
- title
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyTitle(boolean match)
match
- true
to match canonical units with any
title, false
to match canonical units with no
titlemandatory
- This method must be implemented. void clearTitleTerms()
mandatory
- This method must be implemented. void matchCode(java.lang.String code, Type stringMatchType, boolean match)
code
- a codestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- code
is not
of stringMatchType
NullArgumentException
- code
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyCode(boolean match)
match
- true
to match canonical units with any
code, false
to match canonical units with no
codemandatory
- This method must be implemented. void clearCodeTerms()
mandatory
- This method must be implemented. void matchOfferedCyclicTimePeriodId(Id cyclicTimePeriodId, boolean match)
Id
for this query.cyclicTimePeriodId
- a cyclic time period Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- cyclicTimePeriodId
is null
mandatory
- This method must be implemented. void clearOfferedCyclicTimePeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsOfferedCyclicTimePeriodQuery()
CyclicTimePeriodQuery
is available. true
if a cyclic time period query is
available, false
otherwisemandatory
- This method must be implemented. CyclicTimePeriodQuery getOfferedCyclicTimePeriodQuery()
OR
term.UnimplementedException
-
supportsOfferedCyclicTimePeriodQuery()
is false
optional
- This method must be implemented if
supportsOfferedCyclicTimePeriodQuery()
is
true.
void matchAnyOfferedCyclicTimePeriod(boolean match)
match
- true
to match canonicals with any cyclic
time period, false
to match canonicals with no
cyclic time periodsmandatory
- This method must be implemented. void clearOfferedCyclicTimePeriodTerms()
mandatory
- This method must be implemented. void matchResultOptionId(Id gradeSystemId, boolean match)
Id
for this query.gradeSystemId
- a grade system Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearResultOptionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResultOptionQuery()
GradeSystemQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemQuery getResultOptionQuery()
OR
term.UnimplementedException
-
supportsResultOptionQuery()
is false
optional
- This method must be implemented if
supportsGradingOptionQuery()
is true.
void matchAnyResultOption(boolean match)
match
- true
to match canonicals with any grading
option, false
to match canonicals with no
grading optionsmandatory
- This method must be implemented. void clearResultOptionTerms()
mandatory
- This method must be implemented. void matchSponsorId(Id resourceId, boolean match)
Id
for this query to match canonicals
that have a sponsor.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSponsorIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSponsorQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSponsorQuery()
OR
term.UnimplementedException
- supportsSponsorQuery()
is false
optional
- This method must be implemented if
supportsSponsorQuery()
is true.
void matchAnySponsor(boolean match)
match
- true
to match canonicals with any
sponsor, false
to match canonicals with no
sponsorsmandatory
- This method must be implemented. void clearSponsorTerms()
mandatory
- This method must be implemented. void matchCatalogueId(Id catalogueId, boolean match)
Id
for this query to match canonical
units assigned to catalogues.catalogueId
- a catalogue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. void clearCatalogueIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCatalogueQuery()
CatalogueQuery
is available. true
if a catalogue query is available,
false
otherwisemandatory
- This method must be implemented. CatalogueQuery getCatalogueQuery()
OR
term.UnimplementedException
-
supportsCatalogueQuery()
is false
optional
- This method must be implemented if
supportsCatalogueQuery()
is true.
void clearCatalogueTerms()
mandatory
- This method must be implemented. CanonicalUnitQueryRecord getCanonicalUnitQueryRecord(Type canonicalUnitRecordType) throws OperationFailedException
CanonicalUnit
record Type.
Multiple record
retrievals produce a nested OR
term.canonicalUnitRecordType
- a canonical unit record typeNullArgumentException
- canonicalUnitRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitRecordType)
is false
mandatory
- This method must be implemented.