Interface CourseOfferingQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
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 .

  • Method Details

    • matchCourseId

      void matchCourseId(Id courseId, boolean match)
      Sets the course Id for this query to match course offerings that have a related course.
      Parameters:
      courseId - a course Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - courseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseIdTerms

      void clearCourseIdTerms()
      Clears the course Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseQuery

      boolean supportsCourseQuery()
      Tests if a CourseQuery is available.
      Returns:
      true if a course query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseQuery

      CourseQuery getCourseQuery()
      Gets the query for a course. Multiple retrievals produce a nested OR term.
      Returns:
      the course query
      Throws:
      UnimplementedException - supportsCourseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseQuery()} is {@code true} .

    • clearCourseTerms

      void clearCourseTerms()
      Clears the course terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTermId

      void matchTermId(Id termId, boolean match)
      Sets the term Id for this query to match course offerings that have a related term.
      Parameters:
      termId - a term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - termId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTermIdTerms

      void clearTermIdTerms()
      Clears the term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermQuery

      boolean supportsTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTermQuery

      TermQuery getTermQuery()
      Gets the query for a reporting term. Multiple retrievals produce a nested OR term.
      Returns:
      the term query
      Throws:
      UnimplementedException - supportsTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTermQuery()} is {@code true} .

    • clearTermTerms

      void clearTermTerms()
      Clears the term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTitle

      void matchTitle(String title, Type stringMatchType, boolean match)
      Adds a title for this query.
      Parameters:
      title - title string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - title not of stringMatchType
      NullArgumentException - title or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTitle

      void matchAnyTitle(boolean match)
      Matches a title that has any value.
      Parameters:
      match - true to match course offerings with any title, false to match course offerings with no title
      Compliance:
      mandatory - This method must be implemented.

    • clearTitleTerms

      void clearTitleTerms()
      Clears the title terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchNumber

      void matchNumber(String number, Type stringMatchType, boolean match)
      Adds a course number for this query.
      Parameters:
      number - course number string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - number not of stringMatchType
      NullArgumentException - number or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyNumber

      void matchAnyNumber(boolean match)
      Matches a course number that has any value.
      Parameters:
      match - true to match course offerings with any number, false to match course offerings with no number
      Compliance:
      mandatory - This method must be implemented.

    • clearNumberTerms

      void clearNumberTerms()
      Clears the number terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchInstructorId

      void matchInstructorId(Id resourceId, boolean match)
      Sets the resource Id for this query to match course offerings that have an instructor.
      Parameters:
      resourceId - a resource Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearInstructorIdTerms

      void clearInstructorIdTerms()
      Clears the instructor Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsInstructorQuery

      boolean supportsInstructorQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getInstructorQuery

      ResourceQuery getInstructorQuery()
      Gets the query for an instructor. Multiple retrievals produce a nested OR term.
      Returns:
      a resource query
      Throws:
      UnimplementedException - supportsInstructorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsInstructorQuery()} is {@code true} .

    • matchAnyInstructor

      void matchAnyInstructor(boolean match)
      Matches course offerings that have any instructor.
      Parameters:
      match - true to match course offerings with any instructor, false to match course offerings with no instructors
      Compliance:
      mandatory - This method must be implemented.

    • clearInstructorTerms

      void clearInstructorTerms()
      Clears the instructor terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSponsorId

      void matchSponsorId(Id resourceId, boolean match)
      Sets the resource Id for this query to match courses that have a sponsor.
      Parameters:
      resourceId - a resource Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSponsorIdTerms

      void clearSponsorIdTerms()
      Clears the sponsor Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsSponsorQuery

      boolean supportsSponsorQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorQuery

      ResourceQuery getSponsorQuery()
      Gets the query for a sponsor. Multiple retrievals produce a nested OR term.
      Returns:
      a resource query
      Throws:
      UnimplementedException - supportsSponsorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSponsorQuery()} is {@code true} .

    • matchAnySponsor

      void matchAnySponsor(boolean match)
      Matches courses that have any sponsor.
      Parameters:
      match - true to match courses with any sponsor, false to match courses with no sponsors
      Compliance:
      mandatory - This method must be implemented.

    • clearSponsorTerms

      void clearSponsorTerms()
      Clears the sponsor terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditAmountId

      void matchCreditAmountId(Id gradeId, boolean match)
      Sets the grade Id for this query to match courses with a credit amount.
      Parameters:
      gradeId - a grade Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditAmountIdTerms

      void clearCreditAmountIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreditAmountQuery

      boolean supportsCreditAmountQuery()
      Tests if a GradeQuery is available.
      Returns:
      true if a grade query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreditAmountQuery

      GradeQuery getCreditAmountQuery()
      Gets the query for a credit amount. Multiple retrievals produce a nested OR term.
      Returns:
      a grade query
      Throws:
      UnimplementedException - supportsCreditQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreditQuery()} is {@code true} .

    • matchAnyCreditAmount

      void matchAnyCreditAmount(boolean match)
      Matches courses that have any credits amounts.
      Parameters:
      match - true to match courses with any credits false to match courses with no credits
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditAmountTerms

      void clearCreditAmountTerms()
      Clears the credit terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPrerequisitesInfo

      void matchPrerequisitesInfo(String prereqInfo, Type stringMatchType, boolean match)
      Matches course offerings with the prerequisites informational string.
      Parameters:
      prereqInfo - prerequisite informational string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - prereqInfo not of stringMatchType
      NullArgumentException - prereqInfo or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyPrerequisitesInfo

      void matchAnyPrerequisitesInfo(boolean match)
      Matches a course offering that has any prerequisite information assigned.
      Parameters:
      match - true to match course offerings with any prerequisite information, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearPrerequisitesInfoTerms

      void clearPrerequisitesInfoTerms()
      Clears the prerequisite info terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPrerequisitesId

      void matchPrerequisitesId(Id requisiteId, boolean match)
      Sets the requisite Id for this query.
      Parameters:
      requisiteId - a requisite Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - requisiteId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPrerequisitesIdTerms

      void clearPrerequisitesIdTerms()
      Clears the requisite Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsPrerequisitesQuery

      boolean supportsPrerequisitesQuery()
      Tests if a RequisiteQuery is available.
      Returns:
      true if a requisite query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPrerequisitesQuery

      RequisiteQuery getPrerequisitesQuery()
      Gets the query for a requisite. Multiple retrievals produce a nested OR term.
      Returns:
      a prerequisites query
      Throws:
      UnimplementedException - supportsPrerequisitesQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPrerequisitesQuery()} is {@code true} .

    • matchAnyPrerequisites

      void matchAnyPrerequisites(boolean match)
      Matches course offerings that have any prerequisites.
      Parameters:
      match - true to match course offerings with any prerequisites, false to match course offerings with no prerequisites
      Compliance:
      mandatory - This method must be implemented.

    • clearPrerequisitesTerms

      void clearPrerequisitesTerms()
      Clears the prerequisites terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchConcurrentCourseId

      void matchConcurrentCourseId(Id courseId, boolean match)
      Sets the concurrent course Id for this query.
      Parameters:
      courseId - a course Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - courseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearConcurrentCourseIdTerms

      void clearConcurrentCourseIdTerms()
      Clears the concurrent course Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsConcurrentCourseQuery

      boolean supportsConcurrentCourseQuery()
      Tests if a CourseQuery is available.
      Returns:
      true if a course query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getConcurrentCourseQuery

      CourseQuery getConcurrentCourseQuery()
      Gets the query for a concurrent course. Multiple retrievals produce a nested OR term.
      Returns:
      a course query
      Throws:
      UnimplementedException - supportsConcurrentCourseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsConcurrentCourseQuery()} is {@code true} .

    • matchAnyConcurrentCourse

      void matchAnyConcurrentCourse(boolean match)
      Matches courses that have any concurrent courses.
      Parameters:
      match - true to match courses with any concurrent courses, false to match courses with no concurrent courses
      Compliance:
      mandatory - This method must be implemented.

    • clearConcurrentCourseTerms

      void clearConcurrentCourseTerms()
      Clears the concurrent course terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLevelId

      void matchLevelId(Id gradeId, boolean match)
      Sets the grade Id for this query.
      Parameters:
      gradeId - a grade Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLevelIdTerms

      void clearLevelIdTerms()
      Clears the grade Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLevelQuery

      boolean supportsLevelQuery()
      Tests if a GradeQuery is available.
      Returns:
      true if a grade query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLevelQuery

      GradeQuery getLevelQuery()
      Gets the query for a grade level. Multiple retrievals produce a nested OR term.
      Returns:
      a grade query
      Throws:
      UnimplementedException - supportsLevelQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLevelQuery()} is {@code true} .

    • matchAnyLevel

      void matchAnyLevel(boolean match)
      Matches course offerings that have any grade level.
      Parameters:
      match - true to match course offerings with any level, false to match course offerings with no level
      Compliance:
      mandatory - This method must be implemented.

    • clearLevelTerms

      void clearLevelTerms()
      Clears the level terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGradingOptionId

      void matchGradingOptionId(Id gradeSystemId, boolean match)
      Sets the grade system Id for this query.
      Parameters:
      gradeSystemId - a grade system Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGradingOptionIdTerms

      void clearGradingOptionIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradingOptionQuery

      boolean supportsGradingOptionQuery()
      Tests if a GradeSystemQuery is available.
      Returns:
      true if a grade system query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionQuery

      GradeSystemQuery getGradingOptionQuery()
      Gets the query for a grading option. Multiple retrievals produce a nested OR term.
      Returns:
      a grade system query
      Throws:
      UnimplementedException - supportsGradingOptionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradingOptionQuery()} is {@code true} .

    • matchAnyGradingOption

      void matchAnyGradingOption(boolean match)
      Matches course offerings that have any grading option.
      Parameters:
      match - true to match course offerings with any grading option, false to match course offerings with no grading options
      Compliance:
      mandatory - This method must be implemented.

    • clearGradingOptionTerms

      void clearGradingOptionTerms()
      Clears the grading option terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLearningObjectiveId

      void matchLearningObjectiveId(Id objectiveId, boolean match)
      Sets the objective Id for this query.
      Parameters:
      objectiveId - an objective Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - objectiveId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectiveIdTerms

      void clearLearningObjectiveIdTerms()
      Clears the objective Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLearningObjectiveQuery

      boolean supportsLearningObjectiveQuery()
      Tests if a ObjectiveQuery is available.
      Returns:
      true if an objective query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveQuery

      ObjectiveQuery getLearningObjectiveQuery()
      Gets the query for a learning objective. Multiple retrievals produce a nested OR term.
      Returns:
      an objective query
      Throws:
      UnimplementedException - supportsLearningObjectiveQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLearningObjectiveQuery()} is {@code true} .

    • matchAnyLearningObjective

      void matchAnyLearningObjective(boolean match)
      Matches course offerings that have any learning objective.
      Parameters:
      match - true to match course offerings with any learning objective, false to match course offerings with no learning objectives
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectiveTerms

      void clearLearningObjectiveTerms()
      Clears the learning objective terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRestrictedAudienceId

      void matchRestrictedAudienceId(Id resourceId, boolean match)
      Sets the resource Id for this query to match course offerings that have a restricted audience.
      Parameters:
      resourceId - a resource Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRestrictedAudienceIdTerms

      void clearRestrictedAudienceIdTerms()
      Clears the restricted audience Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRestrictedAudienceQuery

      boolean supportsRestrictedAudienceQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRestrictedAudienceQuery

      ResourceQuery getRestrictedAudienceQuery()
      Gets the query for a restricted audience. Multiple retrievals produce a nested OR term.
      Returns:
      a resource query
      Throws:
      UnimplementedException - supportsRestrictedAudienceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRestrictedAudienceQuery()} is {@code true} .

    • matchAnyRestrictedAudience

      void matchAnyRestrictedAudience(boolean match)
      Matches course offerings that have any restricted audience.
      Parameters:
      match - true to match course offerings with any restricted audience, false to match course offerings with no restricted audiences
      Compliance:
      mandatory - This method must be implemented.

    • clearRestrictedAudienceTerms

      void clearRestrictedAudienceTerms()
      Clears the restricted audience terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRequiresRegistration

      void matchRequiresRegistration(boolean match)
      Matches course offerings that require registration.
      Parameters:
      match - true to match course offerings requiring registration,, false to match course offerings not requiring registration
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresRegistrationTerms

      void clearRequiresRegistrationTerms()
      Clears the requires registration terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMinimumSeats

      void matchMinimumSeats(long min, long max, boolean match)
      Matches course offerings with minimum seating between the given numbers inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumSeats

      void matchAnyMinimumSeats(boolean match)
      Matches a course offering that has any minimum seating assigned.
      Parameters:
      match - true to match course offerings with any minimum seats, false to match course offerings with no minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumSeatsTerms

      void clearMinimumSeatsTerms()
      Clears the minimum seats terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMaximumSeats

      void matchMaximumSeats(long min, long max, boolean match)
      Matches course offerings with maximum seating between the given numbers inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMaximumSeats

      void matchAnyMaximumSeats(boolean match)
      Matches a course offering that has any maximum seating assigned.
      Parameters:
      match - true to match course offerings with any maximum seats, false to match course offerings with no maximum seats
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumSeatsTerms

      void clearMaximumSeatsTerms()
      Clears the maximum seats terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchURL

      void matchURL(String url, Type stringMatchType, boolean match)
      Adds a class url for this query.
      Parameters:
      url - url string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - url not of stringMatchType
      NullArgumentException - url or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyURL

      void matchAnyURL(boolean match)
      Matches a url that has any value.
      Parameters:
      match - true to match course offerings with any url, false to match course offerings with no url
      Compliance:
      mandatory - This method must be implemented.

    • clearURLTerms

      void clearURLTerms()
      Clears the url terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScheduleInfo

      void matchScheduleInfo(String scheduleInfo, Type stringMatchType, boolean match)
      Adds a schedule informational string for this query.
      Parameters:
      scheduleInfo - schedule string string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - scheduleInfo not of stringMatchType
      NullArgumentException - scheduleInfo or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyScheduleInfo

      void matchAnyScheduleInfo(boolean match)
      Matches a schedule informational string that has any value.
      Parameters:
      match - true to match course offerings with any schedule string, false to match course offerings with no schedule string
      Compliance:
      mandatory - This method must be implemented.

    • clearScheduleInfoTerms

      void clearScheduleInfoTerms()
      Clears the schedule info terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEventId

      void matchEventId(Id eventId, boolean match)
      Sets the event Id for this query to match course offerings that have an event.
      Parameters:
      eventId - an event Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - eventId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEventIdTerms

      void clearEventIdTerms()
      Clears the event Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsEventQuery

      boolean supportsEventQuery()
      Tests if an EventQuery is available.
      Returns:
      true if an event query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEventQuery

      EventQuery getEventQuery()
      Gets the query for an event. Multiple retrievals produce a nested OR term.
      Returns:
      the event query
      Throws:
      UnimplementedException - supportsEventQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEventQuery()} is {@code true} .

    • matchAnyEvent

      void matchAnyEvent(boolean match)
      Matches any event.
      Parameters:
      match - true to match course offerings with any event., false to match course offerings with no events
      Compliance:
      mandatory - This method must be implemented.

    • clearEventTerms

      void clearEventTerms()
      Clears the event terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchActivityId

      void matchActivityId(Id activityId, boolean match)
      Sets the activity Id for this query to match course offerings that have a related activity.
      Parameters:
      activityId - an activity Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - activityId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearActivityIdTerms

      void clearActivityIdTerms()
      Clears the activity Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityQuery

      boolean supportsActivityQuery()
      Tests if an ActivityQuery is available for the location.
      Returns:
      true if an activity query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getActivityQuery

      ActivityQuery getActivityQuery()
      Gets the query for an activity. Multiple retrievals produce a nested OR term.
      Returns:
      the activity query
      Throws:
      UnimplementedException - supportsActivityQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityQuery()} is {@code true} .

    • matchAnyActivity

      void matchAnyActivity(boolean match)
      Matches any related activity.
      Parameters:
      match - true to match course offerings with any activity, false to match course offerings with no activities
      Compliance:
      mandatory - This method must be implemented.

    • clearActivityTerms

      void clearActivityTerms()
      Clears the activity terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseCatalogId

      void matchCourseCatalogId(Id courseCatalogId, boolean match)
      Sets the course catalog Id for this query to match course offerings assigned to course catalogs.
      Parameters:
      courseCatalogId - the course catalog Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - courseCatalogId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseCatalogIdTerms

      void clearCourseCatalogIdTerms()
      Clears the course catalog Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogQuery

      boolean supportsCourseCatalogQuery()
      Tests if a CourseCatalogQuery is available.
      Returns:
      true if a course catalog query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogQuery

      CourseCatalogQuery getCourseCatalogQuery()
      Gets the query for a course catalog. Multiple retrievals produce a nested OR term.
      Returns:
      the course catalog query
      Throws:
      UnimplementedException - supportsCourseCatalogQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .

    • clearCourseCatalogTerms

      void clearCourseCatalogTerms()
      Clears the course catalog terms.
      Compliance:
      mandatory - This method must be implemented.

    • getCourseOfferingQueryRecord

      CourseOfferingQueryRecord getCourseOfferingQueryRecord(Type courseOfferingRecordType) throws OperationFailedException
      Gets the course offering query record corresponding to the given CourseOffering record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      courseOfferingRecordType - a course offering record type
      Returns:
      the course offering query record
      Throws:
      NullArgumentException - courseOfferingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseOfferingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.