Interface | osid.course.registration.ActivityBundleQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching activity bundles. Each
method match specifies an | ||
Method | matchCourseOfferingId | ||
Description |
Sets the course offering | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseOfferingIdTerms | ||
Description |
Clears the course offering | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseOfferingQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course offering query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseOfferingQuery | ||
Description |
Gets the query for a course offering. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseOfferingQuery | a course offering query | |
Errors | UNIMPLEMENTED | supportsCourseOfferingQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseOfferingQuery()
is true. | |
Method | clearCourseOfferingTerms | ||
Description |
Clears the course offering 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 activity bundles that have any activity. | ||
Parameters | boolean | match | true to match activity bundles with any activity,
false to match activity bundles 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 | matchCredits | ||
Description |
Matches activity bundles with credits between the given numbers inclusive. | ||
Parameters | decimal | min | low number |
decimal | 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 | matchAnyCredits | ||
Description |
Matches an activity bundle that has any credits assigned. | ||
Parameters | boolean | match | true to match activity bundles with any credits,
false to match activity bundles with no credits |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditsTerms | ||
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 activity bundles that have any grading option. | ||
Parameters | boolean | match | true to match activity bundles with any grading option,
false to match activity bundles 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 | 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 | getActivityBundleQueryRecord | ||
Description |
Gets the activity bundle query record corresponding to
the given | ||
Parameters | osid.type.Type | activityBundleRecordType | an activity bundle record type |
Return | osid.course.registration.records.ActivityBundleQueryRecord | the activity bundle query record | |
Errors | NULL_ARGUMENT | activityBundleRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityBundleRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |