OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivityQuery
Implementsosid.OsidRelationshipQuery
osid.OsidSubjugateableQuery
Description

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

MethodmatchImplicit
Description

Matches an activity that is implicitly generated.

Parametersbooleanmatch true to match activities implicitly generated, false to match activities explicitly defined
CompliancemandatoryThis method must be implemented.
MethodclearImplicitTerms
Description

Clears the implcit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityUnitId
Description

Sets the activity unit Id for this query.

Parametersosid.id.IdactivityUnitIdan activity unit Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityUnitId is null
CompliancemandatoryThis method must be implemented.
MethodclearActivityUnitIdTerms
Description

Clears the activity unit Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActivityUnitQuery
Description

Tests if an ActivityUnitQuery is available.

Returnboolean true if an activity unit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitQuery
Description

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

Returnosid.course.ActivityUnitQuerythe activity unit query
ErrorsUNIMPLEMENTED supportsActivityUnitQuery() is false
ComplianceoptionalThis method must be implemented if supportsActivityUnitQuery() is true.
MethodclearActivityUnitTerms
Description

Clears the activity unit terms.

CompliancemandatoryThis method must be implemented.
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 coure offering. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseOfferingQuerythe 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.
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.
MethodmatchMeetingTime
Description

Matches activities where the given time falls within a denormalized meeting time inclusive.

Parametersosid.calendaring.DateTimedatea date
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearMeetingTimeTerms
Description

Clears the meeting time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMeetingTimeInclusive
Description

Matches activities with any denormalized meeting time within the given date range inclusive.

Parametersosid.calendaring.DateTimestarta start date
osid.calendaring.DateTimeendan end date
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodclearMeetingTimeInclusiveTerms
Description

Clears the meeting time inclusive terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMeetingLocationId
Description

Matches activities with any meeting location.

Parametersosid.id.IdlocationIda location Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT locationId is null
CompliancemandatoryThis method must be implemented.
MethodclearMeetingLocationIdTerms
Description

Clears the location Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsMeetingLocationQuery
Description

Tests if a LocationQuery is available.

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

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

Returnosid.mapping.LocationQuerythe location query
ErrorsUNIMPLEMENTED supportsMeetingLocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsMeetingLocationQuery() is true.
MethodclearMeetingLocationTerms
Description

Clears the location Id terms.

CompliancemandatoryThis method must be implemented.
MethodmatchScheduleId
Description

Sets the schedule Id for this query.

Parametersosid.id.IdscheduleIda schedule Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT scheduleId is null
CompliancemandatoryThis method must be implemented.
MethodclearScheduleIdTerms
Description

Clears the schedule Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsScheduleQuery
Description

Tests if a ScheduleQuery is available.

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

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

Returnosid.calendaring.ScheduleQuerythe schedule query
ErrorsUNIMPLEMENTED supportsScheduleQuery() is false
ComplianceoptionalThis method must be implemented if supportsScheduleQuery() is true.
MethodmatchAnySchedule
Description

Matches an activity that has any schedule.

Parametersbooleanmatch true to match activitiies with any schedule, false to match activitiies with no schedule
CompliancemandatoryThis method must be implemented.
MethodclearScheduleTerms
Description

Clears the schedule terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSupersedingActivityId
Description

Sets the superseding activity Id for this query.

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

Clears the superseding activity Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSupersedingActivityQuery
Description

Tests if an ActivityQuery is available.

Returnboolean true if a superseding activity query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingActivityQuery
Description

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

Returnosid.course.ActivityQuerythe superseding activity query
ErrorsUNIMPLEMENTED supportsSupersedingActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingActivityQuery() is true.
MethodmatchAnySupersedingActivity
Description

Matches an activity that has any superseding activity.

Parametersbooleanmatch true to match activitiies with any superseding activity, false to match activitiies with no superseding activities
CompliancemandatoryThis method must be implemented.
MethodclearSupersedingActivityTerms
Description

Clears the superseding activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSpecificMeetingTime
Description

Matches activities with specific dates between the given range inclusive.

Parametersosid.calendaring.DateTimestartstart date
osid.calendaring.DateTimeendend date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT end is less than start
NULL_ARGUMENT start or end is zero
CompliancemandatoryThis method must be implemented.
MethodmatchAnySpecificMeetingTime
Description

Matches an activity that has any specific date.

Parametersbooleanmatch true to match activitiies with any specific date, false to match activitiies with no specific dates
CompliancemandatoryThis method must be implemented.
MethodclearSpecificMeetingTimeTerms
Description

Clears the specific date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBlackout
Description

Matches activities containing the given blackout date.

Parametersosid.calendaring.DateTimedatea date
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyBlackout
Description

Matches an activity that has any blackout.

Parametersbooleanmatch true to match activitiies with any blackout, false to match activitiies with no blackouts
CompliancemandatoryThis method must be implemented.
MethodclearBlackoutTerms
Description

Clears all blackout terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBlackoutInclusive
Description

Matches activities with blackouts within the given date range inclousive.

Parametersosid.calendaring.DateTimestarta start date
osid.calendaring.DateTimeendan end date
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT star t or end is null
CompliancemandatoryThis method must be implemented.
MethodclearBlackoutInclusiveTerms
Description

Clears all blackout inclusive 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.
MethodmatchMinimumSeats
Description

Matches activities with a 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 activities with any minimum seating assigned.

Parametersbooleanmatch true to match activities with any minimum seating, false to match activities with no minimum seating
CompliancemandatoryThis method must be implemented.
MethodclearMinimumSeatsTerms
Description

Clears the minimum seating terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMaximumSeats
Description

Matches activities with a 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 activities with any maximum seating assigned.

Parametersbooleanmatch true to match activities with any maximum seating, false to match activities with no maximum seating
CompliancemandatoryThis method must be implemented.
MethodclearMaximumSeatsTerms
Description

Clears the maximum seating terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalTargetEffort
Description

Matches activities with a total effort between the given durations inclusive.

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTotalTargetEffort
Description

Matches an activity that has any total effort assigned.

Parametersbooleanmatch true to match activities with any total effort, false to match activities with no total effort
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetEffortTerms
Description

Clears the total effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContact
Description

Matches activities that are contact activities.

Parametersbooleanmatch true to match activities that have contact, false to match activities with no contact
CompliancemandatoryThis method must be implemented.
MethodclearContactTerms
Description

Clears the contact terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalTargetContactTime
Description

Matches activities with a total contact time between the given durations inclusive.

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTotalTargetContactTime
Description

Matches an activity that has any total contact assigned.

Parametersbooleanmatch true to match activities with any total contatc, false to match activities with no total contact
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetContactTimeTerms
Description

Clears the total contact terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalTargetIndividualEffort
Description

Matches activities with a individual effort between the given durations inclusive.

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTotalTargetIndividualEffort
Description

Matches an activity that has any individual effort assigned.

Parametersbooleanmatch true to match activities with any individual effort, false to match activities with no individual effort
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetIndividualEffortTerms
Description

Clears the individual effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRecurringWeekly
Description

Matches activities that recur weekly.

Parametersbooleanmatch true to match activities that recur weekly, false to match activities with no weekly recurrance
CompliancemandatoryThis method must be implemented.
MethodclearRecurringWeeklyTerms
Description

Clears the recurring weekly terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyEffort
Description

Matches activities with a weekly effort between the given durations inclusive.

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyEffort
Description

Matches an activity that has any weekly effort assigned.

Parametersbooleanmatch true to match activities with any weekly effort, false to match activities with no weekly effort
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyEffortTerms
Description

Clears the weekly effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyContactTime
Description

Matches activities with a weekly contact time between the given durations inclusive.

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyContactTime
Description

Matches an activity that has any weekly contact time assigned.

Parametersbooleanmatch true to match activities with any weekly contact time, false to match activities with no weekly contact time
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyContactTimeTerms
Description

Clears the weekly contact time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyIndividualEffort
Description

Matches activities with a weekly individual effort between the given durations inclusive.

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyIndividualEffort
Description

Matches an activity that has any weekly individual effort assigned.

Parametersbooleanmatch true to match activities with any weekly individual effort, false to match activities with no weekly individual effort
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyIndividualEffortTerms
Description

Clears the weekly individual effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

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

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

Parametersosid.type.TypeactivityRecordTypean activity record type
Returnosid.course.records.ActivityQueryRecordthe activity query record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.