public interface CourseOfferingQuery extends OsidRelationshipQuery
This is the query for searching course offerings. 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 |
clearActivityIdTerms()
Clears the activity
Id terms. |
void |
clearActivityTerms()
Clears the activity terms.
|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearCourseIdTerms()
Clears the course
Id terms. |
void |
clearCourseTerms()
Clears the course terms.
|
void |
clearCreditAmountIdTerms()
Clears the grade system
Id terms. |
void |
clearCreditAmountTerms()
Clears the credit terms.
|
void |
clearEventIdTerms()
Clears the event
Id terms. |
void |
clearEventTerms()
Clears the event terms.
|
void |
clearGradingOptionIdTerms()
Clears the grade system
Id terms. |
void |
clearGradingOptionTerms()
Clears the grading option terms.
|
void |
clearInstructorIdTerms()
Clears the instructor
Id terms. |
void |
clearInstructorTerms()
Clears the instructor terms.
|
void |
clearMaximumSeatsTerms()
Clears the maximum seats terms.
|
void |
clearMinimumSeatsTerms()
Clears the minimum seats terms.
|
void |
clearNumberTerms()
Clears the number terms.
|
void |
clearRequiresRegistrationTerms()
Clears the requires registration terms.
|
void |
clearScheduleInfoTerms()
Clears the schedule info terms.
|
void |
clearSponsorIdTerms()
Clears the sponsor
Id terms. |
void |
clearSponsorTerms()
Clears the sponsor terms.
|
void |
clearTermIdTerms()
Clears the term
Id terms. |
void |
clearTermTerms()
Clears the term terms.
|
void |
clearTitleTerms()
Clears the title terms.
|
void |
clearURLTerms()
Clears the url terms.
|
ActivityQuery |
getActivityQuery()
Gets the query for an activity.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseOfferingQueryRecord |
getCourseOfferingQueryRecord(Type courseOfferingRecordType)
Gets the course offering query record corresponding to the given
CourseOffering record Type. |
CourseQuery |
getCourseQuery()
Gets the query for a course.
|
GradeQuery |
getCreditAmountQuery()
Gets the query for a credit amount.
|
EventQuery |
getEventQuery()
Gets the query for an event.
|
GradeSystemQuery |
getGradingOptionQuery()
Gets the query for a grading option.
|
ResourceQuery |
getInstructorQuery()
Gets the query for an instructor.
|
ResourceQuery |
getSponsorQuery()
Gets the query for a sponsor.
|
TermQuery |
getTermQuery()
Gets the query for a reporting term.
|
void |
matchActivityId(Id activityId,
boolean match)
Sets the activity
Id for this query to match course
offerings that have a related activity. |
void |
matchAnyActivity(boolean match)
Matches any related activity.
|
void |
matchAnyCreditAmount(boolean match)
Matches courses that have any credits amounts.
|
void |
matchAnyEvent(boolean match)
Matches any event.
|
void |
matchAnyGradingOption(boolean match)
Matches course offerings that have any grading option.
|
void |
matchAnyInstructor(boolean match)
Matches course offerings that have any instructor.
|
void |
matchAnyMaximumSeats(boolean match)
Matches a course offering that has any maximum seating assigned.
|
void |
matchAnyMinimumSeats(boolean match)
Matches a course offering that has any minimum seating assigned.
|
void |
matchAnyNumber(boolean match)
Matches a course number that has any value.
|
void |
matchAnyScheduleInfo(boolean match)
Matches a schedule informational string that has any value.
|
void |
matchAnySponsor(boolean match)
Matches courses that have any sponsor.
|
void |
matchAnyTitle(boolean match)
Matches a title that has any value.
|
void |
matchAnyURL(boolean match)
Matches a url that has any value.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query to match
course offerings assigned to course catalogs. |
void |
matchCourseId(Id courseId,
boolean match)
Sets the course
Id for this query to match course
offerings that have a related course. |
void |
matchCreditAmountId(Id gradeId,
boolean match)
Sets the grade
Id for this query to match courses with
a credit amount. |
void |
matchEventId(Id eventId,
boolean match)
Sets the event
Id for this query to match course
offerings that have an event. |
void |
matchGradingOptionId(Id gradeSystemId,
boolean match)
Sets the grade system
Id for this query. |
void |
matchInstructorId(Id resourceId,
boolean match)
Sets the resource
Id for this query to match course
offerings that have an instructor. |
void |
matchMaximumSeats(long min,
long max,
boolean match)
Matches course offerings with maximum seating between the given
numbers inclusive.
|
void |
matchMinimumSeats(long min,
long max,
boolean match)
Matches course offerings with minimum seating between the given
numbers inclusive.
|
void |
matchNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Adds a course number for this query.
|
void |
matchRequiresRegistration(boolean match)
Matches course offerings that require registration.
|
void |
matchScheduleInfo(java.lang.String scheduleInfo,
Type stringMatchType,
boolean match)
Adds a schedule informational string for this query.
|
void |
matchSponsorId(Id resourceId,
boolean match)
Sets the resource
Id for this query to match courses
that have a sponsor. |
void |
matchTermId(Id termId,
boolean match)
Sets the term
Id for this query to match course
offerings that have a related term. |
void |
matchTitle(java.lang.String title,
Type stringMatchType,
boolean match)
Adds a title for this query.
|
void |
matchURL(java.lang.String url,
Type stringMatchType,
boolean match)
Adds a class url for this query.
|
boolean |
supportsActivityQuery()
Tests if an
ActivityQuery is available for the
location. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseQuery()
Tests if a
CourseQuery is available. |
boolean |
supportsCreditAmountQuery()
Tests if a
GradeQuery is available. |
boolean |
supportsEventQuery()
Tests if an
EventQuery is available. |
boolean |
supportsGradingOptionQuery()
Tests if a
GradeSystemQuery is available. |
boolean |
supportsInstructorQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsSponsorQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsTermQuery()
Tests if a
TermQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQueryclearCommentIdTerms, 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, supportsSubjectRelevancyQueryclearIdTerms, matchIdclearRecordTerms, matchAnyRecord, matchRecordTypegetRecordTypes, hasRecordTypeclearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchTypeclearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDatevoid matchCourseId(Id courseId, boolean match)
Id for this query to match course
offerings that have a related course.courseId - a course Id match - true if a positive match, false
for a negative matchNullArgumentException - courseId is
null mandatory - This method must be implemented. void clearCourseIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsCourseQuery()
CourseQuery is available. true if a course query is available,
false otherwisemandatory - This method must be implemented. CourseQuery getCourseQuery()
OR term.UnimplementedException - supportsCourseQuery()
is false optional - This method must be implemented if
supportsCourseQuery() is true. void clearCourseTerms()
mandatory - This method must be implemented. void matchTermId(Id termId, boolean match)
Id for this query to match course
offerings that have a related term.termId - a term Id match - true if a positive match, false
for a negative matchNullArgumentException - termId is
null mandatory - This method must be implemented. void clearTermIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsTermQuery()
TermQuery is available. true if a term query is available, false
otherwisemandatory - This method must be implemented. TermQuery getTermQuery()
OR term.UnimplementedException - supportsTermQuery()
is false optional - This method must be implemented if
supportsTermQuery() is true. void clearTermTerms()
mandatory - This method must be implemented. void matchTitle(java.lang.String title,
Type stringMatchType,
boolean match)
title - title string to matchstringMatchType - the string match typematch - true for a positive match, false
for a negative matchInvalidArgumentException - title 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 course offerings with any
title, false to match course offerings with no
titlemandatory - This method must be implemented. void clearTitleTerms()
mandatory - This method must be implemented. void matchNumber(java.lang.String number,
Type stringMatchType,
boolean match)
number - course number string to matchstringMatchType - the string match typematch - true for a positive match, false
for a negative matchInvalidArgumentException - number not of
stringMatchType NullArgumentException - number or
stringMatchType is null UnsupportedException -
supportsStringMatchType(stringMatchType) is
false mandatory - This method must be implemented. void matchAnyNumber(boolean match)
match - true to match course offerings with any
number, false to match course offerings with no
numbermandatory - This method must be implemented. void clearNumberTerms()
mandatory - This method must be implemented. void matchInstructorId(Id resourceId, boolean match)
Id for this query to match course
offerings that have an instructor.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 clearInstructorIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsInstructorQuery()
ResourceQuery is available. true if a resource query is available,
false otherwisemandatory - This method must be implemented. ResourceQuery getInstructorQuery()
OR term.UnimplementedException -
supportsInstructorQuery() is false optional - This method must be implemented if
supportsInstructorQuery() is true. void matchAnyInstructor(boolean match)
match - true to match course offerings with any
instructor, false to match course offerings
with no instructorsmandatory - This method must be implemented. void clearInstructorTerms()
mandatory - This method must be implemented. void matchSponsorId(Id resourceId, boolean match)
Id for this query to match courses
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 courses with any sponsor,
false to match courses with no sponsorsmandatory - This method must be implemented. void clearSponsorTerms()
mandatory - This method must be implemented. void matchCreditAmountId(Id gradeId, boolean match)
Id for this query to match courses with
a credit amount.gradeId - a grade Id match - true if a positive match, false
for a negative matchNullArgumentException - gradeId is
null mandatory - This method must be implemented. void clearCreditAmountIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsCreditAmountQuery()
GradeQuery is available. true if a grade query is available,
false otherwisemandatory - This method must be implemented. GradeQuery getCreditAmountQuery()
OR term.UnimplementedException - supportsCreditQuery()
is false optional - This method must be implemented if
supportsCreditQuery() is true. void matchAnyCreditAmount(boolean match)
match - true to match courses with any credits
false to match courses with no creditsmandatory - This method must be implemented. void clearCreditAmountTerms()
mandatory - This method must be implemented. void matchGradingOptionId(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 clearGradingOptionIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsGradingOptionQuery()
GradeSystemQuery is available. true if a grade system query is available,
false otherwisemandatory - This method must be implemented. GradeSystemQuery getGradingOptionQuery()
OR term.UnimplementedException -
supportsGradingOptionQuery() is false optional - This method must be implemented if
supportsGradingOptionQuery() is true.
void matchAnyGradingOption(boolean match)
match - true to match course offerings with any
grading option, false to match course offerings
with no grading optionsmandatory - This method must be implemented. void clearGradingOptionTerms()
mandatory - This method must be implemented. void matchRequiresRegistration(boolean match)
match - true to match course offerings requiring
registration,, false to match course offerings
not requiring registrationmandatory - This method must be implemented. void clearRequiresRegistrationTerms()
mandatory - This method must be implemented. void matchMinimumSeats(long min,
long max,
boolean match)
min - low numbermax - high numbermatch - true for a positive match, false
for a negative matchInvalidArgumentException - max is less
than min mandatory - This method must be implemented. void matchAnyMinimumSeats(boolean match)
match - true to match course offerings with any
minimum seats, false to match course offerings
with no minimum seatsmandatory - This method must be implemented. void clearMinimumSeatsTerms()
mandatory - This method must be implemented. void matchMaximumSeats(long min,
long max,
boolean match)
min - low numbermax - high numbermatch - true for a positive match, false
for a negative matchInvalidArgumentException - max is less
than min mandatory - This method must be implemented. void matchAnyMaximumSeats(boolean match)
match - true to match course offerings with any
maximum seats, false to match course offerings
with no maximum seatsmandatory - This method must be implemented. void clearMaximumSeatsTerms()
mandatory - This method must be implemented. void matchURL(java.lang.String url,
Type stringMatchType,
boolean match)
url - url string to matchstringMatchType - the string match typematch - true for a positive match, false
for a negative matchInvalidArgumentException - url not of
stringMatchType NullArgumentException - url or
stringMatchType is null UnsupportedException -
supportsStringMatchType(stringMatchType) is
false mandatory - This method must be implemented. void matchAnyURL(boolean match)
match - true to match course offerings with any
url, false to match course offerings with no
urlmandatory - This method must be implemented. void clearURLTerms()
mandatory - This method must be implemented. void matchScheduleInfo(java.lang.String scheduleInfo,
Type stringMatchType,
boolean match)
scheduleInfo - schedule string string to matchstringMatchType - the string match typematch - true for a positive match, false
for a negative matchInvalidArgumentException - scheduleInfo
not of stringMatchType NullArgumentException - scheduleInfo or
stringMatchType is null UnsupportedException -
supportsStringMatchType(stringMatchType) is
false mandatory - This method must be implemented. void matchAnyScheduleInfo(boolean match)
match - true to match course offerings with any
schedule string, false to match course
offerings with no schedule stringmandatory - This method must be implemented. void clearScheduleInfoTerms()
mandatory - This method must be implemented. void matchEventId(Id eventId, boolean match)
Id for this query to match course
offerings that have an event.eventId - an event Id match - true if a positive match, false
for a negative matchNullArgumentException - eventId is
null mandatory - This method must be implemented. void clearEventIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsEventQuery()
EventQuery is available. true if an event query is available,
false otherwisemandatory - This method must be implemented. EventQuery getEventQuery()
OR term.UnimplementedException - supportsEventQuery()
is false optional - This method must be implemented if
supportsEventQuery() is true. void matchAnyEvent(boolean match)
match - true to match course offerings with any
event., false to match course offerings with no
eventsmandatory - This method must be implemented. void clearEventTerms()
mandatory - This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id for this query to match course
offerings that have a related activity.activityId - an activity Id match - true if a positive match, false
for a negative matchNullArgumentException - activityId is
null mandatory - This method must be implemented. void clearActivityIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsActivityQuery()
ActivityQuery is available for the
location. true if an activity query is available,
false otherwisemandatory - This method must be implemented. ActivityQuery getActivityQuery()
OR term.UnimplementedException - supportsActivityQuery()
is false optional - This method must be implemented if
supportsActivityQuery() is true. void matchAnyActivity(boolean match)
match - true to match course offerings with any
activity, false to match course offerings with
no activitiesmandatory - This method must be implemented. void clearActivityTerms()
mandatory - This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id for this query to match
course offerings 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 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. CourseOfferingQueryRecord getCourseOfferingQueryRecord(Type courseOfferingRecordType) throws OperationFailedException
CourseOffering record Type. Multiple
record retrievals produce a nested OR term.courseOfferingRecordType - a course offering record typeNullArgumentException - courseOfferingRecordType
is null OperationFailedException - unable to complete requestUnsupportedException -
hasRecordType(courseOfferingRecordType) is
false mandatory - This method must be implemented.