OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseOfferingQuery
Implementsosid.OsidRelationshipQuery
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.IdcourseIda course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseIdTerms
Description

Clears the course Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseQuery
Description

Tests if a CourseQuery is available.

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

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

Returnosid.course.CourseQuerythe course query
ErrorsUNIMPLEMENTED supportsCourseQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseQuery() is true.
MethodclearCourseTerms
Description

Clears the course terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTermId
Description

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

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

Clears the term Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTermQuery
Description

Tests if a TermQuery is available.

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

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

Returnosid.course.TermQuerythe term query
ErrorsUNIMPLEMENTED supportsTermQuery() is false
ComplianceoptionalThis method must be implemented if supportsTermQuery() is true.
MethodclearTermTerms
Description

Clears the term terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTitle
Description

Adds a title for this query.

Parametersstringtitletitle string to match
osid.type.TypestringMatchTypethe 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
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearTitleTerms
Description

Clears the title terms.

CompliancemandatoryThis method must be implemented.
MethodmatchNumber
Description

Adds a course number for this query.

Parametersstringnumbercourse number string to match
osid.type.TypestringMatchTypethe 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
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearNumberTerms
Description

Clears the number terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInstructorId
Description

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

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

Clears the instructor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInstructorQuery
Description

Tests if a ResourceQuery is available.

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

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

Returnosid.resource.ResourceQuerya resource query
ErrorsUNIMPLEMENTED supportsInstructorQuery() is false
ComplianceoptionalThis 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
CompliancemandatoryThis method must be implemented.
MethodclearInstructorTerms
Description

Clears the instructor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSponsorId
Description

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

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

Clears the sponsor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSponsorQuery
Description

Tests if a ResourceQuery is available.

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

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

Returnosid.resource.ResourceQuerya resource query
ErrorsUNIMPLEMENTED supportsSponsorQuery() is false
ComplianceoptionalThis 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
CompliancemandatoryThis method must be implemented.
MethodclearSponsorTerms
Description

Clears the sponsor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCreditAmountId
Description

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

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

Clears the grade system Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCreditAmountQuery
Description

Tests if a GradeQuery is available.

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

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

Returnosid.grading.GradeQuerya grade query
ErrorsUNIMPLEMENTED supportsCreditQuery() is false
ComplianceoptionalThis 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
CompliancemandatoryThis method must be implemented.
MethodclearCreditAmountTerms
Description

Clears the credit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradingOptionId
Description

Sets the grade system Id for this query.

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

Clears the grade system Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradingOptionQuery
Description

Tests if a GradeSystemQuery is available.

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

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

Returnosid.grading.GradeSystemQuerya grade system query
ErrorsUNIMPLEMENTED supportsGradingOptionQuery() is false
ComplianceoptionalThis 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
CompliancemandatoryThis method must be implemented.
MethodclearGradingOptionTerms
Description

Clears the grading option terms.

CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearRequiresRegistrationTerms
Description

Clears the requires registration terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumSeats
Description

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

Parameterscardinalminlow number
cardinalmaxhigh number
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearMinimumSeatsTerms
Description

Clears the minimum seats terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMaximumSeats
Description

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

Parameterscardinalminlow number
cardinalmaxhigh number
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearMaximumSeatsTerms
Description

Clears the maximum seats terms.

CompliancemandatoryThis method must be implemented.
MethodmatchURL
Description

Adds a class url for this query.

Parametersstringurlurl string to match
osid.type.TypestringMatchTypethe 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
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearURLTerms
Description

Clears the url terms.

CompliancemandatoryThis method must be implemented.
MethodmatchScheduleInfo
Description

Adds a schedule informational string for this query.

ParametersstringscheduleInfoschedule string string to match
osid.type.TypestringMatchTypethe 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
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodclearScheduleInfoTerms
Description

Clears the schedule info terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEventId
Description

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

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

Clears the event Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEventQuery
Description

Tests if an EventQuery is available.

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

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

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsEventQuery() is false
ComplianceoptionalThis 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
CompliancemandatoryThis method must be implemented.
MethodclearEventTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

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

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

Clears the activity Id terms.

CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetActivityQuery
Description

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

Returnosid.course.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsActivityQuery() is false
ComplianceoptionalThis 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
CompliancemandatoryThis method must be implemented.
MethodclearActivityTerms
Description

Clears the activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

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

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

Clears the course catalog Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

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

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

Returnosid.course.CourseCatalogQuerythe course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

CompliancemandatoryThis 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.TypecourseOfferingRecordTypea course offering record type
Returnosid.course.records.CourseOfferingQueryRecordthe course offering query record
ErrorsNULL_ARGUMENT courseOfferingRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseOfferingRecordType) is false
CompliancemandatoryThis method must be implemented.