OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.CourseOfferingQuery
Implementsosid.OsidRelationshipQuery
Used Byosid.course.ActivityQuery
osid.course.CourseCatalogQuery
osid.course.CourseOfferingQuerySession
osid.course.CourseOfferingSearchSession
osid.course.CourseOfferingSmartCourseCatalogSession
osid.course.CourseQuery
osid.course.TermQuery
osid.course.plan.PlanQuery
osid.course.registration.CourseRegistrationQuery
osid.course.registration.RegistrationTargetQuery
Description

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.

MethodmatchCourseId
Description

Sets the course Id for this query to match course offerings that have a related course.

Parametersosid.id.IdcourseId a course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
Compliancemandatory This method must be implemented.
MethodclearCourseIdTerms
Description

Clears the course Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsCourseQuery
Description

Tests if a CourseQuery is available.

Returnboolean true if a course query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCourseQuery
Description

Gets the query for a course. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseQuery the course query
ErrorsUNIMPLEMENTED supportsCourseQuery() is false
Complianceoptional This method must be implemented if supportsCourseQuery() is true.
MethodclearCourseTerms
Description

Clears the course terms.

Compliancemandatory This method must be implemented.
MethodmatchTermId
Description

Sets the term Id for this query to match course offerings that have a related term.

Parametersosid.id.IdtermId a term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT termId is null
Compliancemandatory This method must be implemented.
MethodclearTermIdTerms
Description

Clears the term Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsTermQuery
Description

Tests if a TermQuery is available.

Returnboolean true if a term query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetTermQuery
Description

Gets the query for a reporting term. Multiple retrievals produce a nested OR term.

Returnosid.course.TermQuery the term query
ErrorsUNIMPLEMENTED supportsTermQuery() is false
Complianceoptional This method must be implemented if supportsTermQuery() is true.
MethodclearTermTerms
Description

Clears the term terms.

Compliancemandatory This method must be implemented.
MethodmatchTitle
Description

Adds a title for this query.

Parametersstringtitle title string to match
osid.type.TypestringMatchType the string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT title not of stringMatchType
NULL_ARGUMENT title or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
Compliancemandatory This method must be implemented.
MethodmatchAnyTitle
Description

Matches a title that has any value.

Parametersbooleanmatch true to match course offerings with any title, false to match course offerings with no title
Compliancemandatory This method must be implemented.
MethodclearTitleTerms
Description

Clears the title terms.

Compliancemandatory This method must be implemented.
MethodmatchNumber
Description

Adds a course number for this query.

Parametersstringnumber course number string to match
osid.type.TypestringMatchType the string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT number not of stringMatchType
NULL_ARGUMENT number or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
Compliancemandatory This method must be implemented.
MethodmatchAnyNumber
Description

Matches a course number that has any value.

Parametersbooleanmatch true to match course offerings with any number, false to match course offerings with no number
Compliancemandatory This method must be implemented.
MethodclearNumberTerms
Description

Clears the number terms.

Compliancemandatory This method must be implemented.
MethodmatchInstructorId
Description

Sets the resource Id for this query to match course offerings that have an instructor.

Parametersosid.id.IdresourceId a resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
Compliancemandatory This method must be implemented.
MethodclearInstructorIdTerms
Description

Clears the instructor Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsInstructorQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetInstructorQuery
Description

Gets the query for an instructor. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuery a resource query
ErrorsUNIMPLEMENTED supportsInstructorQuery() is false
Complianceoptional This method must be implemented if supportsInstructorQuery() is true.
MethodmatchAnyInstructor
Description

Matches course offerings that have any instructor.

Parametersbooleanmatch true to match course offerings with any instructor, false to match course offerings with no instructors
Compliancemandatory This method must be implemented.
MethodclearInstructorTerms
Description

Clears the instructor terms.

Compliancemandatory This method must be implemented.
MethodmatchSponsorId
Description

Sets the resource Id for this query to match courses that have a sponsor.

Parametersosid.id.IdresourceId a resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
Compliancemandatory This method must be implemented.
MethodclearSponsorIdTerms
Description

Clears the sponsor Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsSponsorQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetSponsorQuery
Description

Gets the query for a sponsor. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuery a resource query
ErrorsUNIMPLEMENTED supportsSponsorQuery() is false
Complianceoptional This method must be implemented if supportsSponsorQuery() is true.
MethodmatchAnySponsor
Description

Matches courses that have any sponsor.

Parametersbooleanmatch true to match courses with any sponsor, false to match courses with no sponsors
Compliancemandatory This method must be implemented.
MethodclearSponsorTerms
Description

Clears the sponsor terms.

Compliancemandatory This method must be implemented.
MethodmatchCreditAmountId
Description

Sets the grade Id for this query to match courses with a credit amount.

Parametersosid.id.IdgradeId a grade Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeId is null
Compliancemandatory This method must be implemented.
MethodclearCreditAmountIdTerms
Description

Clears the grade system Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsCreditAmountQuery
Description

Tests if a GradeQuery is available.

Returnboolean true if a grade query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCreditAmountQuery
Description

Gets the query for a credit amount. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeQuery a grade query
ErrorsUNIMPLEMENTED supportsCreditQuery() is false
Complianceoptional This method must be implemented if supportsCreditQuery() is true.
MethodmatchAnyCreditAmount
Description

Matches courses that have any credits amounts.

Parametersbooleanmatch true to match courses with any credits false to match courses with no credits
Compliancemandatory This method must be implemented.
MethodclearCreditAmountTerms
Description

Clears the credit terms.

Compliancemandatory This method must be implemented.
MethodmatchPrerequisitesInfo
Description

Matches course offerings with the prerequisites informational string.

ParametersstringprereqInfo prerequisite informational string to match
osid.type.TypestringMatchType the string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT prereqInfo not of stringMatchType
NULL_ARGUMENT prereqInfo or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
Compliancemandatory This method must be implemented.
MethodmatchAnyPrerequisitesInfo
Description

Matches a course offering that has any prerequisite information assigned.

Parametersbooleanmatch true to match course offerings with any prerequisite information, false otherwise
Compliancemandatory This method must be implemented.
MethodclearPrerequisitesInfoTerms
Description

Clears the prerequisite info terms.

Compliancemandatory This method must be implemented.
MethodmatchPrerequisitesId
Description

Sets the requisite Id for this query.

Parametersosid.id.IdrequisiteId a requisite Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT requisiteId is null
Compliancemandatory This method must be implemented.
MethodclearPrerequisitesIdTerms
Description

Clears the requisite Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsPrerequisitesQuery
Description

Tests if a RequisiteQuery is available.

Returnboolean true if a requisite query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetPrerequisitesQuery
Description

Gets the query for a requisite. Multiple retrievals produce a nested OR term.

Returnosid.course.requisite.RequisiteQuery a prerequisites query
ErrorsUNIMPLEMENTED supportsPrerequisitesQuery() is false
Complianceoptional This method must be implemented if supportsPrerequisitesQuery() is true.
MethodmatchAnyPrerequisites
Description

Matches course offerings that have any prerequisites.

Parametersbooleanmatch true to match course offerings with any prerequisites, false to match course offerings with no prerequisites
Compliancemandatory This method must be implemented.
MethodclearPrerequisitesTerms
Description

Clears the prerequisites terms.

Compliancemandatory This method must be implemented.
MethodmatchConcurrentCourseId
Description

Sets the concurrent course Id for this query.

Parametersosid.id.IdcourseId a course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
Compliancemandatory This method must be implemented.
MethodclearConcurrentCourseIdTerms
Description

Clears the concurrent course Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsConcurrentCourseQuery
Description

Tests if a CourseQuery is available.

Returnboolean true if a course query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetConcurrentCourseQuery
Description

Gets the query for a concurrent course. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseQuery a course query
ErrorsUNIMPLEMENTED supportsConcurrentCourseQuery() is false
Complianceoptional This method must be implemented if supportsConcurrentCourseQuery() is true.
MethodmatchAnyConcurrentCourse
Description

Matches courses that have any concurrent courses.

Parametersbooleanmatch true to match courses with any concurrent courses, false to match courses with no concurrent courses
Compliancemandatory This method must be implemented.
MethodclearConcurrentCourseTerms
Description

Clears the concurrent course terms.

Compliancemandatory This method must be implemented.
MethodmatchLevelId
Description

Sets the grade Id for this query.

Parametersosid.id.IdgradeId a grade Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeId is null
Compliancemandatory This method must be implemented.
MethodclearLevelIdTerms
Description

Clears the grade Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsLevelQuery
Description

Tests if a GradeQuery is available.

Returnboolean true if a grade query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetLevelQuery
Description

Gets the query for a grade level. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeQuery a grade query
ErrorsUNIMPLEMENTED supportsLevelQuery() is false
Complianceoptional This method must be implemented if supportsLevelQuery() is true.
MethodmatchAnyLevel
Description

Matches course offerings that have any grade level.

Parametersbooleanmatch true to match course offerings with any level, false to match course offerings with no level
Compliancemandatory This method must be implemented.
MethodclearLevelTerms
Description

Clears the level terms.

Compliancemandatory This method must be implemented.
MethodmatchGradingOptionId
Description

Sets the grade system Id for this query.

Parametersosid.id.IdgradeSystemId a grade system Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeSystemId is null
Compliancemandatory This method must be implemented.
MethodclearGradingOptionIdTerms
Description

Clears the grade system Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsGradingOptionQuery
Description

Tests if a GradeSystemQuery is available.

Returnboolean true if a grade system query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetGradingOptionQuery
Description

Gets the query for a grading option. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeSystemQuery a grade system query
ErrorsUNIMPLEMENTED supportsGradingOptionQuery() is false
Complianceoptional This method must be implemented if supportsGradingOptionQuery() is true.
MethodmatchAnyGradingOption
Description

Matches course offerings that have any grading option.

Parametersbooleanmatch true to match course offerings with any grading option, false to match course offerings with no grading options
Compliancemandatory This method must be implemented.
MethodclearGradingOptionTerms
Description

Clears the grading option terms.

Compliancemandatory This method must be implemented.
MethodmatchLearningObjectiveId
Description

Sets the objective Id for this query.

Parametersosid.id.IdobjectiveId an objective Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
Compliancemandatory This method must be implemented.
MethodclearLearningObjectiveIdTerms
Description

Clears the objective Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsLearningObjectiveQuery
Description

Tests if a ObjectiveQuery is available.

Returnboolean true if an objective query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetLearningObjectiveQuery
Description

Gets the query for a learning objective. Multiple retrievals produce a nested OR term.

Returnosid.learning.ObjectiveQuery an objective query
ErrorsUNIMPLEMENTED supportsLearningObjectiveQuery() is false
Complianceoptional This method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyLearningObjective
Description

Matches course offerings that have any learning objective.

Parametersbooleanmatch true to match course offerings with any learning objective, false to match course offerings with no learning objectives
Compliancemandatory This method must be implemented.
MethodclearLearningObjectiveTerms
Description

Clears the learning objective terms.

Compliancemandatory This method must be implemented.
MethodmatchRestrictedAudienceId
Description

Sets the resource Id for this query to match course offerings that have a restricted audience.

Parametersosid.id.IdresourceId a resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
Compliancemandatory This method must be implemented.
MethodclearRestrictedAudienceIdTerms
Description

Clears the restricted audience Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsRestrictedAudienceQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetRestrictedAudienceQuery
Description

Gets the query for a restricted audience. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuery a resource query
ErrorsUNIMPLEMENTED supportsRestrictedAudienceQuery() is false
Complianceoptional This method must be implemented if supportsRestrictedAudienceQuery() is true.
MethodmatchAnyRestrictedAudience
Description

Matches course offerings that have any restricted audience.

Parametersbooleanmatch true to match course offerings with any restricted audience, false to match course offerings with no restricted audiences
Compliancemandatory This method must be implemented.
MethodclearRestrictedAudienceTerms
Description

Clears the restricted audience terms.

Compliancemandatory This method must be implemented.
MethodmatchRequiresRegistration
Description

Matches course offerings that require registration.

Parametersbooleanmatch true to match course offerings requiring registration,, false to match course offerings not requiring registration
Compliancemandatory This method must be implemented.
MethodclearRequiresRegistrationTerms
Description

Clears the requires registration terms.

Compliancemandatory This method must be implemented.
MethodmatchMinimumSeats
Description

Matches course offerings with minimum seating between the given numbers inclusive.

Parameterscardinalmin low number
cardinalmax high number
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
Compliancemandatory This method must be implemented.
MethodmatchAnyMinimumSeats
Description

Matches a course offering that has any minimum seating assigned.

Parametersbooleanmatch true to match course offerings with any minimum seats, false to match course offerings with no minimum seats
Compliancemandatory This method must be implemented.
MethodclearMinimumSeatsTerms
Description

Clears the minimum seats terms.

Compliancemandatory This method must be implemented.
MethodmatchMaximumSeats
Description

Matches course offerings with maximum seating between the given numbers inclusive.

Parameterscardinalmin low number
cardinalmax high number
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
Compliancemandatory This method must be implemented.
MethodmatchAnyMaximumSeats
Description

Matches a course offering that has any maximum seating assigned.

Parametersbooleanmatch true to match course offerings with any maximum seats, false to match course offerings with no maximum seats
Compliancemandatory This method must be implemented.
MethodclearMaximumSeatsTerms
Description

Clears the maximum seats terms.

Compliancemandatory This method must be implemented.
MethodmatchURL
Description

Adds a class url for this query.

Parametersstringurl url string to match
osid.type.TypestringMatchType the string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT url not of stringMatchType
NULL_ARGUMENT url or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
Compliancemandatory This method must be implemented.
MethodmatchAnyURL
Description

Matches a url that has any value.

Parametersbooleanmatch true to match course offerings with any url, false to match course offerings with no url
Compliancemandatory This method must be implemented.
MethodclearURLTerms
Description

Clears the url terms.

Compliancemandatory This method must be implemented.
MethodmatchScheduleInfo
Description

Adds a schedule informational string for this query.

ParametersstringscheduleInfo schedule string string to match
osid.type.TypestringMatchType the string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT scheduleInfo not of stringMatchType
NULL_ARGUMENT scheduleInfo or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
Compliancemandatory This method must be implemented.
MethodmatchAnyScheduleInfo
Description

Matches a schedule informational string that has any value.

Parametersbooleanmatch true to match course offerings with any schedule string, false to match course offerings with no schedule string
Compliancemandatory This method must be implemented.
MethodclearScheduleInfoTerms
Description

Clears the schedule info terms.

Compliancemandatory This method must be implemented.
MethodmatchEventId
Description

Sets the event Id for this query to match course offerings that have an event.

Parametersosid.id.IdeventId an event Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
Compliancemandatory This method must be implemented.
MethodclearEventIdTerms
Description

Clears the event Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsEventQuery
Description

Tests if an EventQuery is available.

Returnboolean true if an event query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetEventQuery
Description

Gets the query for an event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuery the event query
ErrorsUNIMPLEMENTED supportsEventQuery() is false
Complianceoptional This method must be implemented if supportsEventQuery() is true.
MethodmatchAnyEvent
Description

Matches any event.

Parametersbooleanmatch true to match course offerings with any event., false to match course offerings with no events
Compliancemandatory This method must be implemented.
MethodclearEventTerms
Description

Clears the event terms.

Compliancemandatory This method must be implemented.
MethodmatchActivityId
Description

Sets the activity Id for this query to match course offerings that have a related activity.

Parametersosid.id.IdactivityId an activity Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityId is null
Compliancemandatory This method must be implemented.
MethodclearActivityIdTerms
Description

Clears the activity Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsActivityQuery
Description

Tests if an ActivityQuery is available for the location.

Returnboolean true if an activity query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetActivityQuery
Description

Gets the query for an activity. Multiple retrievals produce a nested OR term.

Returnosid.course.ActivityQuery the activity query
ErrorsUNIMPLEMENTED supportsActivityQuery() is false
Complianceoptional This method must be implemented if supportsActivityQuery() is true.
MethodmatchAnyActivity
Description

Matches any related activity.

Parametersbooleanmatch true to match course offerings with any activity, false to match course offerings with no activities
Compliancemandatory This method must be implemented.
MethodclearActivityTerms
Description

Clears the activity terms.

Compliancemandatory This method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match course offerings assigned to course catalogs.

Parametersosid.id.IdcourseCatalogId the course catalog Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseCatalogId is null
Compliancemandatory This method must be implemented.
MethodclearCourseCatalogIdTerms
Description

Clears the course catalog Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

Returnboolean true if a course catalog query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCourseCatalogQuery
Description

Gets the query for a course catalog. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseCatalogQuery the course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
Complianceoptional This method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

Compliancemandatory This method must be implemented.
MethodgetCourseOfferingQueryRecord
Description

Gets the course offering query record corresponding to the given CourseOffering record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypecourseOfferingRecordType a course offering record type
Returnosid.course.records.CourseOfferingQueryRecord the course offering query record
ErrorsNULL_ARGUMENT courseOfferingRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(courseOfferingRecordType) is false
Compliancemandatory This method must be implemented.