OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.ActivityBundleQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching activity bundles. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchCourseOfferingId
Description

Sets the course offering Id for this query.

Parametersosid.id.IdcourseOfferingIda course offering Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseOfferingId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseOfferingIdTerms
Description

Clears the course offering Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseOfferingQuery
Description

Tests if a CourseOfferingQuery is available.

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

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

Returnosid.course.CourseOfferingQuerya course offering query
ErrorsUNIMPLEMENTED supportsCourseOfferingQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseOfferingQuery() is true.
MethodclearCourseOfferingTerms
Description

Clears the course offering terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

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

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.

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 activity bundles that have any activity.

Parametersbooleanmatch true to match activity bundles with any activity, false to match activity bundles with no activities
CompliancemandatoryThis method must be implemented.
MethodclearActivityTerms
Description

Clears the activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCredits
Description

Matches activity bundles with credits between the given numbers inclusive.

Parametersdecimalminlow number
decimalmaxhigh number
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCredits
Description

Matches an activity bundle that has any credits assigned.

Parametersbooleanmatch true to match activity bundles with any credits, false to match activity bundles with no credits
CompliancemandatoryThis method must be implemented.
MethodclearCreditsTerms
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 activity bundles that have any grading option.

Parametersbooleanmatch true to match activity bundles with any grading option, false to match activity bundles with no grading options
CompliancemandatoryThis method must be implemented.
MethodclearGradingOptionTerms
Description

Clears the grading option terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match activity bundles 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.
MethodgetActivityBundleQueryRecord
Description

Gets the activity bundle query record corresponding to the given Course record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeactivityBundleRecordTypean activity bundle record type
Returnosid.course.registration.records.ActivityBundleQueryRecordthe activity bundle query record
ErrorsNULL_ARGUMENT activityBundleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityBundleRecordType) is false
CompliancemandatoryThis method must be implemented.