Interface | osid.course.CourseOfferingQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching course offerings. Each
method match specifies an | ||
Method | matchCourseId | ||
Description |
Sets the course | ||
Parameters | osid.id.Id | courseId | a course Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseIdTerms | ||
Description |
Clears the course | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseQuery | ||
Description |
Gets the query for a course. Multiple retrievals
produce a nested | ||
Return | osid.course.CourseQuery | the course query | |
Errors | UNIMPLEMENTED | supportsCourseQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseQuery() is
true. | |
Method | clearCourseTerms | ||
Description |
Clears the course terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTermId | ||
Description |
Sets the term | ||
Parameters | osid.id.Id | termId | a term Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | termId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearTermIdTerms | ||
Description |
Clears the term | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsTermQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a term query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTermQuery | ||
Description |
Gets the query for a reporting term. Multiple
retrievals produce a nested | ||
Return | osid.course.TermQuery | the term query | |
Errors | UNIMPLEMENTED | supportsTermQuery() is false | |
Compliance | optional | This method must be implemented if supportsTermQuery() is
true. | |
Method | clearTermTerms | ||
Description |
Clears the term terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTitle | ||
Description |
Adds a title for this query. | ||
Parameters | string | title | title string to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | title not of stringMatchType | |
NULL_ARGUMENT | title or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTitle | ||
Description |
Matches a title that has any value. | ||
Parameters | boolean | match | true to match course offerings with any title, false
to match course offerings with no title |
Compliance | mandatory | This method must be implemented. | |
Method | clearTitleTerms | ||
Description |
Clears the title terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchNumber | ||
Description |
Adds a course number for this query. | ||
Parameters | string | number | course number string to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | number not of stringMatchType | |
NULL_ARGUMENT | number or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyNumber | ||
Description |
Matches a course number that has any value. | ||
Parameters | boolean | match | true to match course offerings with any number, false
to match course offerings with no number |
Compliance | mandatory | This method must be implemented. | |
Method | clearNumberTerms | ||
Description |
Clears the number terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInstructorId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstructorIdTerms | ||
Description |
Clears the instructor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInstructorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructorQuery | ||
Description |
Gets the query for an instructor. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | a resource query | |
Errors | UNIMPLEMENTED | supportsInstructorQuery() is false | |
Compliance | optional | This method must be implemented if supportsInstructorQuery()
is true. | |
Method | matchAnyInstructor | ||
Description |
Matches course offerings that have any instructor. | ||
Parameters | boolean | match | true to match course offerings with any instructor,
false to match course offerings with no instructors |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstructorTerms | ||
Description |
Clears the instructor terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSponsorId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSponsorIdTerms | ||
Description |
Clears the sponsor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSponsorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsorQuery | ||
Description |
Gets the query for a sponsor. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | a resource query | |
Errors | UNIMPLEMENTED | supportsSponsorQuery() is false | |
Compliance | optional | This method must be implemented if supportsSponsorQuery() is
true. | |
Method | matchAnySponsor | ||
Description |
Matches courses that have any sponsor. | ||
Parameters | boolean | match | true to match courses with any sponsor, false
to match courses with no sponsors |
Compliance | mandatory | This method must be implemented. | |
Method | clearSponsorTerms | ||
Description |
Clears the sponsor terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreditAmountId | ||
Description |
Sets the grade | ||
Parameters | osid.id.Id | gradeId | a grade Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditAmountIdTerms | ||
Description |
Clears the grade system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditAmountQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditAmountQuery | ||
Description |
Gets the query for a credit amount. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeQuery | a grade query | |
Errors | UNIMPLEMENTED | supportsCreditQuery() is false | |
Compliance | optional | This method must be implemented if supportsCreditQuery() is
true. | |
Method | matchAnyCreditAmount | ||
Description |
Matches courses that have any credits amounts. | ||
Parameters | boolean | match | true to match courses with any credits false
to match courses with no credits |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditAmountTerms | ||
Description |
Clears the credit terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGradingOptionId | ||
Description |
Sets the grade system | ||
Parameters | osid.id.Id | gradeSystemId | a grade system Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradingOptionIdTerms | ||
Description |
Clears the grade system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradingOptionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradingOptionQuery | ||
Description |
Gets the query for a grading option. Multiple
retrievals produce a nested | ||
Return | osid.grading.GradeSystemQuery | a grade system query | |
Errors | UNIMPLEMENTED | supportsGradingOptionQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradingOptionQuery()
is true. | |
Method | matchAnyGradingOption | ||
Description |
Matches course offerings that have any grading option. | ||
Parameters | boolean | 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. | |
Method | clearGradingOptionTerms | ||
Description |
Clears the grading option terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRequiresRegistration | ||
Description |
Matches course offerings that require registration. | ||
Parameters | boolean | match | true to match course offerings requiring registration,,
false to match course offerings not requiring registration |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiresRegistrationTerms | ||
Description |
Clears the requires registration terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumSeats | ||
Description |
Matches course offerings with minimum seating between the given numbers inclusive. | ||
Parameters | cardinal | min | low number |
cardinal | max | high number | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyMinimumSeats | ||
Description |
Matches a course offering that has any minimum seating assigned. | ||
Parameters | boolean | 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. | |
Method | clearMinimumSeatsTerms | ||
Description |
Clears the minimum seats terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMaximumSeats | ||
Description |
Matches course offerings with maximum seating between the given numbers inclusive. | ||
Parameters | cardinal | min | low number |
cardinal | max | high number | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyMaximumSeats | ||
Description |
Matches a course offering that has any maximum seating assigned. | ||
Parameters | boolean | 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. | |
Method | clearMaximumSeatsTerms | ||
Description |
Clears the maximum seats terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchURL | ||
Description |
Adds a class url for this query. | ||
Parameters | string | url | url string to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | url not of stringMatchType | |
NULL_ARGUMENT | url or stringMatchType is null | ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyURL | ||
Description |
Matches a url that has any value. | ||
Parameters | boolean | match | true to match course offerings with any url, false
to match course offerings with no url |
Compliance | mandatory | This method must be implemented. | |
Method | clearURLTerms | ||
Description |
Clears the url terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchScheduleInfo | ||
Description |
Adds a schedule informational string for this query. | ||
Parameters | string | scheduleInfo | schedule string string to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | scheduleInfo not of stringMatchType | |
NULL_ARGUMENT | scheduleInfo or stringMatchType is
null | ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyScheduleInfo | ||
Description |
Matches a schedule informational string that has any value. | ||
Parameters | boolean | 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. | |
Method | clearScheduleInfoTerms | ||
Description |
Clears the schedule info terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchEventId | ||
Description |
Sets the event | ||
Parameters | osid.id.Id | eventId | an event Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | eventId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearEventIdTerms | ||
Description |
Clears the event | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsEventQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an event query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventQuery | ||
Description |
Gets the query for an event. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.EventQuery | the event query | |
Errors | UNIMPLEMENTED | supportsEventQuery() is false | |
Compliance | optional | This method must be implemented if supportsEventQuery() is
true. | |
Method | matchAnyEvent | ||
Description |
Matches any event. | ||
Parameters | boolean | match | true to match course offerings with any event., false
to match course offerings with no events |
Compliance | mandatory | This method must be implemented. | |
Method | clearEventTerms | ||
Description |
Clears the event terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchActivityId | ||
Description |
Sets the activity | ||
Parameters | osid.id.Id | activityId | an activity Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | activityId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityIdTerms | ||
Description |
Clears the activity | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivityQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an activity query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityQuery | ||
Description |
Gets the query for an activity. Multiple retrievals
produce a nested | ||
Return | osid.course.ActivityQuery | the activity query | |
Errors | UNIMPLEMENTED | supportsActivityQuery() is false | |
Compliance | optional | This method must be implemented if supportsActivityQuery()
is true. | |
Method | matchAnyActivity | ||
Description |
Matches any related activity. | ||
Parameters | boolean | match | true to match course offerings with any activity,
false to match course offerings with no activities |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityTerms | ||
Description |
Clears the activity terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseCatalogId | ||
Description |
Sets the course catalog | ||
Parameters | osid.id.Id | courseCatalogId | the course catalog Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseCatalogIdTerms | ||
Description |
Clears the course catalog | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseCatalogQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course catalog query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogQuery | ||
Description |
Gets the query for a course catalog. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseCatalogQuery | the course catalog query | |
Errors | UNIMPLEMENTED | supportsCourseCatalogQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseCatalogQuery()
is true. | |
Method | clearCourseCatalogTerms | ||
Description |
Clears the course catalog terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseOfferingQueryRecord | ||
Description |
Gets the course offering query record corresponding to
the given | ||
Parameters | osid.type.Type | courseOfferingRecordType | a course offering record type |
Return | osid.course.records.CourseOfferingQueryRecord | the course offering query record | |
Errors | NULL_ARGUMENT | courseOfferingRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(courseOfferingRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |