public interface TermQuery extends OsidObjectQuery, OsidFederateableQuery
This is the query for searching terms. Each method match specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAddDateTerms()
Clears the add date query terms.
|
void |
clearAncestorTermIdTerms()
Clears the ancestor term
Id query terms. |
void |
clearAncestorTermTerms()
Clears the ancestor term query terms.
|
void |
clearClassesDurationTerms()
Clears the classes period duration query terms.
|
void |
clearClassesEndTerms()
Clears the class end date query terms.
|
void |
clearClassesPeriodTerms()
Clears the class period query terms.
|
void |
clearClassesStartTerms()
Clears the class start date query terms.
|
void |
clearCloseDateTerms()
Clears the close date query terms.
|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id query terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog query terms.
|
void |
clearCourseOfferingIdTerms()
Clears the course offering
Id query terms. |
void |
clearCourseOfferingTerms()
Clears the course offering query terms.
|
void |
clearDescendantTermIdTerms()
Clears the descendant term
Id query terms. |
void |
clearDescendantTermTerms()
Clears the descendant term query terms.
|
void |
clearDisplayLabelTerms()
Clears the display label query terms.
|
void |
clearDropDateTerms()
Clears the drop date query terms.
|
void |
clearFinalExamDurationTerms()
Clears the final exam period duration query terms.
|
void |
clearFinalExamEndTerms()
Clears the final exam period end date query terms.
|
void |
clearFinalExamPeriodTerms()
Clears the final exam period query terms.
|
void |
clearFinalExamStartTerms()
Clears the final exam start date query terms.
|
void |
clearOpenDateTerms()
Clears the open date query terms.
|
void |
clearRegistrationDurationTerms()
Clears the registration period duration query terms.
|
void |
clearRegistrationEndTerms()
Clears the registration end date query terms.
|
void |
clearRegistrationPeriodTerms()
Clears the registration period query terms.
|
void |
clearRegistrationStartTerms()
Clears the registration start date query terms.
|
TermQuery |
getAncestorTermQuery()
Gets the query for a term.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseOfferingQuery |
getCourseOfferingQuery()
Gets the query for a course offering.
|
TermQuery |
getDescendantTermQuery()
Gets the query for a term.
|
TermQueryRecord |
getTermQueryRecord(Type termRecordType)
Gets the term query record corresponding to the given
Term
record Type. |
void |
matchAddDate(DateTime low,
DateTime high,
boolean match)
Matches the add date between the given range inclusive.
|
void |
matchAncestorTermId(Id termId,
boolean match)
Sets the term
Id for this query to match terms that
have the specified term as an ancestor. |
void |
matchAnyAddDate(boolean match)
Matches a term that has any add date assigned.
|
void |
matchAnyAncestorTerm(boolean match)
Matches terms with any ancestor.
|
void |
matchAnyClassesEnd(boolean match)
Matches a term that has any class end date assigned.
|
void |
matchAnyClassesStart(boolean match)
Matches a term that has any class start date assigned.
|
void |
matchAnyCloseDate(boolean match)
Matches a term that has any close date assigned.
|
void |
matchAnyCourseOffering(boolean match)
Matches courses that have any course offering.
|
void |
matchAnyDescendantTerm(boolean match)
Matches terms with any descendant.
|
void |
matchAnyDisplayLabel(boolean match)
Matches a display label that has any value.
|
void |
matchAnyDropDate(boolean match)
Matches a term that has any drop date assigned.
|
void |
matchAnyFinalExamEnd(boolean match)
Matches a term that has any final exam period end date assigned.
|
void |
matchAnyFinalExamStart(boolean match)
Matches a term that has any final exam period start date assigned.
|
void |
matchAnyOpenDate(boolean match)
Matches a term that has any open date assigned.
|
void |
matchAnyRegistrationEnd(boolean match)
Matches a term that has any registration end date assigned.
|
void |
matchAnyRegistrationStart(boolean match)
Matches a term that has any registration start date assigned.
|
void |
matchClassesDuration(Duration low,
Duration high,
boolean match)
Matches the classes period duration between the given range inclusive.
|
void |
matchClassesEnd(DateTime low,
DateTime high,
boolean match)
Matches the class end date between the given range inclusive.
|
void |
matchClassesPeriod(DateTime date,
boolean match)
Matches the class period that incudes the given date.
|
void |
matchClassesStart(DateTime low,
DateTime high,
boolean match)
Matches the class start date between the given range inclusive.
|
void |
matchCloseDate(DateTime low,
DateTime high,
boolean match)
Matches the close date between the given range inclusive.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query to match
terms assigned to course catalogs. |
void |
matchCourseOfferingId(Id courseOfferingId,
boolean match)
Sets the course offering
Id for this query to match
terms assigned to course offerings. |
void |
matchDescendantTermId(Id termId,
boolean match)
Sets the term
Id for this query to match terms that
have the specified term as a descendant. |
void |
matchDisplayLabel(java.lang.String label,
Type stringMatchType,
boolean match)
Adds a display label for this query.
|
void |
matchDropDate(DateTime low,
DateTime high,
boolean match)
Matches the drop date between the given range inclusive.
|
void |
matchFinalExamDuration(Duration low,
Duration high,
boolean match)
Matches the final exam period duration between the given range
inclusive.
|
void |
matchFinalExamEnd(DateTime low,
DateTime high,
boolean match)
Matches the final exam period end date between the given range
inclusive.
|
void |
matchFinalExamPeriod(DateTime date,
boolean match)
Matches the final exam period that incudes the given date.
|
void |
matchFinalExamStart(DateTime low,
DateTime high,
boolean match)
Matches the final exam period start date between the given range
inclusive.
|
void |
matchOpenDate(DateTime low,
DateTime high,
boolean match)
Matches the open date between the given range inclusive.
|
void |
matchRegistrationDuration(Duration low,
Duration high,
boolean match)
Matches the registration period duration between the given range
inclusive.
|
void |
matchRegistrationEnd(DateTime low,
DateTime high,
boolean match)
Matches the registration end date between the given range inclusive.
|
void |
matchRegistrationPeriod(DateTime date,
boolean match)
Matches the registration period that incudes the given date.
|
void |
matchRegistrationStart(DateTime low,
DateTime high,
boolean match)
Matches the registration start date between the given range inclusive.
|
boolean |
supportsAncestorTermQuery()
Tests if a
TermQuery is available. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseOfferingQuery()
Tests if a
CourseOfferingQuery is available. |
boolean |
supportsDescendantTermQuery()
Tests if a
TermQuery 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 matchDisplayLabel(java.lang.String label, Type stringMatchType, boolean match)
label
- label string to matchstringMatchType
- the label match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- label
not of
stringMatchType
NullArgumentException
- label
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyDisplayLabel(boolean match)
match
- true
to match courses with any label,
false
to match assets with no titlemandatory
- This method must be implemented. void clearDisplayLabelTerms()
mandatory
- This method must be implemented. void matchOpenDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyOpenDate(boolean match)
match
- true
to match terms with any open date,
false
to match terms with no open datemandatory
- This method must be implemented. void clearOpenDateTerms()
mandatory
- This method must be implemented. void matchRegistrationStart(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyRegistrationStart(boolean match)
match
- true
to match terms with any registration
start date, false
to match terms with no
registration start datemandatory
- This method must be implemented. void clearRegistrationStartTerms()
mandatory
- This method must be implemented. void matchRegistrationEnd(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyRegistrationEnd(boolean match)
match
- true
to match terms with any registration
end date, false
to match terms with no
registration end datemandatory
- This method must be implemented. void clearRegistrationEndTerms()
mandatory
- This method must be implemented. void matchRegistrationPeriod(DateTime date, boolean match)
date
- a datematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearRegistrationPeriodTerms()
mandatory
- This method must be implemented. void matchRegistrationDuration(Duration low, Duration high, boolean match)
low
- low duration rangehigh
- high duration rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void clearRegistrationDurationTerms()
mandatory
- This method must be implemented. void matchClassesStart(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyClassesStart(boolean match)
match
- true
to match terms with any class start
date, false
to match terms with no class start
datemandatory
- This method must be implemented. void clearClassesStartTerms()
mandatory
- This method must be implemented. void matchClassesEnd(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyClassesEnd(boolean match)
match
- true
to match terms with any class end
date, false
to match terms with no class end
datemandatory
- This method must be implemented. void clearClassesEndTerms()
mandatory
- This method must be implemented. void matchClassesPeriod(DateTime date, boolean match)
date
- a datematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearClassesPeriodTerms()
mandatory
- This method must be implemented. void matchClassesDuration(Duration low, Duration high, boolean match)
low
- low duration rangehigh
- high duration rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void clearClassesDurationTerms()
mandatory
- This method must be implemented. void matchAddDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyAddDate(boolean match)
match
- true
to match terms with any add date,
false
to match terms with no add/drop datemandatory
- This method must be implemented. void clearAddDateTerms()
mandatory
- This method must be implemented. void matchDropDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyDropDate(boolean match)
match
- true
to match terms with any drop date,
false
to match terms with no add/drop datemandatory
- This method must be implemented. void clearDropDateTerms()
mandatory
- This method must be implemented. void matchFinalExamStart(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyFinalExamStart(boolean match)
match
- true
to match terms with any final exam
start date, false
to match terms with no final
exam start datemandatory
- This method must be implemented. void clearFinalExamStartTerms()
mandatory
- This method must be implemented. void matchFinalExamEnd(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyFinalExamEnd(boolean match)
match
- true
to match terms with any final exam
end date, false
to match terms with no final
exam end datemandatory
- This method must be implemented. void clearFinalExamEndTerms()
mandatory
- This method must be implemented. void matchFinalExamPeriod(DateTime date, boolean match)
date
- a datematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearFinalExamPeriodTerms()
mandatory
- This method must be implemented. void matchFinalExamDuration(Duration low, Duration high, boolean match)
low
- low duration rangehigh
- high duration rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void clearFinalExamDurationTerms()
mandatory
- This method must be implemented. void matchCloseDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyCloseDate(boolean match)
match
- true
to match terms with any close date,
false
to match terms with no close datemandatory
- This method must be implemented. void clearCloseDateTerms()
mandatory
- This method must be implemented. void matchAncestorTermId(Id termId, boolean match)
Id
for this query to match terms that
have the specified term as an ancestor.termId
- a term Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- termId
is
null
mandatory
- This method must be implemented. void clearAncestorTermIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorTermQuery()
TermQuery
is available. true
if a termency query is available,
false
otherwisemandatory
- This method must be implemented. TermQuery getAncestorTermQuery()
OR
term.UnimplementedException
-
supportsAncestorTermQuery()
is false
optional
- This method must be implemented if
supportsAncestorTermQuery()
is true.
void matchAnyAncestorTerm(boolean match)
match
- true
to match terms with any ancestor,
false
to match root termsmandatory
- This method must be implemented. void clearAncestorTermTerms()
mandatory
- This method must be implemented. void matchDescendantTermId(Id termId, boolean match)
Id
for this query to match terms that
have the specified term as a descendant.termId
- a term Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- termId
is
null
mandatory
- This method must be implemented. void clearDescendantTermIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantTermQuery()
TermQuery
is available. true
if a termency query is available,
false
otherwisemandatory
- This method must be implemented. TermQuery getDescendantTermQuery()
OR
term.UnimplementedException
-
supportsDescendantTermQuery()
is false
optional
- This method must be implemented if
supportsDescendantTermQuery()
is true.
void matchAnyDescendantTerm(boolean match)
match
- true
to match terms with any Ddscendant,
false
to match leaf termsmandatory
- This method must be implemented. void clearDescendantTermTerms()
mandatory
- This method must be implemented. void matchCourseOfferingId(Id courseOfferingId, boolean match)
Id
for this query to match
terms assigned to course offerings.courseOfferingId
- the course offering Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseOfferingId
is null
mandatory
- This method must be implemented. void clearCourseOfferingIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCourseOfferingQuery()
CourseOfferingQuery
is available. true
if a course offering query is available,
false
otherwisemandatory
- This method must be implemented. CourseOfferingQuery getCourseOfferingQuery()
OR
term.UnimplementedException
-
supportsCourseOfferingQuery()
is false
optional
- This method must be implemented if
supportsCourseOfferingQuery()
is true.
void matchAnyCourseOffering(boolean match)
match
- true
to match terms with any course
offering, false
to match terms with no course
offeringsmandatory
- This method must be implemented. void clearCourseOfferingTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
terms assigned to course catalogs.courseCatalogId
- the course catalog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. void clearCourseCatalogIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCourseCatalogQuery()
CourseCatalogQuery
is available. true
if a course catalog query is available,
false
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
OR
term.UnimplementedException
-
supportsCourseCatalogQuery()
is false
optional
- This method must be implemented if
supportsCourseCatalogQuery()
is true.
void clearCourseCatalogTerms()
mandatory
- This method must be implemented. TermQueryRecord getTermQueryRecord(Type termRecordType) throws OperationFailedException
Term
record Type.
Multiple record retrievals produce
a nested OR
term.termRecordType
- a term record typeNullArgumentException
- termRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(termRecordType)
is false
mandatory
- This method must be implemented.