OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.LessonQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchPlanId
Description

Sets the plan Id for this query.

Parametersosid.id.IdplanIda plan Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT planId is null
CompliancemandatoryThis method must be implemented.
MethodclearPlanIdTerms
Description

Clears the plan Id tems.

CompliancemandatoryThis method must be implemented.
MethodsupportsPlanQuery
Description

Tests if a plan query is available.

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

Gets the query for a plan.

Returnosid.course.plan.PlanQuerythe plan query
ErrorsUNIMPLEMENTED supportsPlanQuery() is false
ComplianceoptionalThis method must be implemented if supportsPlanQuery() is true.
MethodclearPlanTerms
Description

Clears the plan terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDocetId
Description

Sets the docet Id for this query.

Parametersosid.id.IddocetIda docet Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT docetId is null
CompliancemandatoryThis method must be implemented.
MethodclearDocetIdTerms
Description

Clears the docet Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDocetQuery
Description

Tests if a docet query is available.

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

Gets the query for a docet.

Returnosid.course.syllabus.DocetQuerythe docet query
ErrorsUNIMPLEMENTED supportsDocetQuery() is false
ComplianceoptionalThis method must be implemented if supportsDocetQuery() is true.
MethodmatchAnyDocet
Description

Matches a lesson that has any docet.

Parametersbooleanmatch true to match lessons with any docet, false to match lessons with no docet
CompliancemandatoryThis method must be implemented.
MethodclearDocetTerms
Description

Clears the docet terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

Sets the activity Id for this query.

Parametersosid.id.IdactivitytIdan activity Id
booleanmatch true for 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 activity query 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.

Returnosid.course.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsActivityQuery() is true.
MethodmatchAnyActivity
Description

Matches a lesson that has any activity.

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

Clears the activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPlannedStartTime
Description

Matches a planned start time within the given duration range inclusive.

Parametersosid.calendaring.Durationfroma starting date
osid.calendaring.Durationtoa ending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPlannedStartTime
Description

Matches a lesson that has any planned start time.

Parametersbooleanmatch true to match lessons with any planned start time, false to match lessons with no planned start time
CompliancemandatoryThis method must be implemented.
MethodclearPlannedStartTimeTerms
Description

Clears the planned start time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActualStartTime
Description

Matches an actual start time within the given date range inclusive.

Parametersosid.calendaring.Durationfroma starting date
osid.calendaring.Durationtoa ending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyActualStartTime
Description

Matches a lesson that has begun.

Parametersbooleanmatch true to match lessons with any actual start time, false to match lessons with no actual start time
CompliancemandatoryThis method must be implemented.
MethodclearActualStartTimeTerms
Description

Clears the actual start time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActualStartingActivityId
Description

Sets the starting activity Id for this query.

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

Clears the starting activity Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActualStartingActivityQuery
Description

Tests if a starting activity query is available.

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

Gets the query for a starting activity.

Returnosid.course.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsActualStartingActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsActualStartingActivityQuery() is true.
MethodmatchAnyActualStartingActivity
Description

Matches a lesson that has any starting activity.

Parametersbooleanmatch true to match lessons with any starting activity, false to match lessons with no starting activity
CompliancemandatoryThis method must be implemented.
MethodclearActualStartingActivityTerms
Description

Clears the starting activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchComplete
Description

Matches a lesson that has been completed.

Parametersbooleanmatch true to match lessons that have been completed, false to match lessons that have not been completed
CompliancemandatoryThis method must be implemented.
MethodclearCompleteTerms
Description

Clears the complete terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSkipped
Description

Matches a lesson that has been skipped.

Parametersbooleanmatch true to match lessons that have been skipped, false to match lessons that have not been skipped
CompliancemandatoryThis method must be implemented.
MethodclearSkippedTerms
Description

Clears the skipped terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActualEndTime
Description

Matches an actual ending time within the given date range inclusive.

Parametersosid.calendaring.Durationfroma starting date
osid.calendaring.Durationtoa ending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyActualEndTime
Description

Matches a lesson that has any actual end time.

Parametersbooleanmatch true to match lessons with any actual end time, false to match lessons with no actual end time
CompliancemandatoryThis method must be implemented.
MethodclearActualEndTimeTerms
Description

Clears the actual end time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActualEndingActivityId
Description

Sets the ending activity Id for this query.

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

Clears the ending activity Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActualEndingActivityQuery
Description

Tests if an ending activity query is available.

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

Gets the query for an ending activity.

Returnosid.course.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsEndingActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsEndingActivityQuery() is true.
MethodmatchAnyActualEndingActivity
Description

Matches a lesson that has any ending activity.

Parametersbooleanmatch true to match lessons with any ending activity, false to match lessons with no ending activity
CompliancemandatoryThis method must be implemented.
MethodclearActualEndingActivityTerms
Description

Clears the ending activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActualTimeSpent
Description

Matches an actual time spent within the given duration range inclusive.

Parametersosid.calendaring.Durationfroma starting date
osid.calendaring.Durationtoa ending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyActualTimeSpent
Description

Matches a lesson that has any actual time spent.

Parametersbooleanmatch true to match lessons with any actual time spent, false to match lessons with no time spent
CompliancemandatoryThis method must be implemented.
MethodclearActualTimeSpentTerms
Description

Clears the actual time spent terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the lesson Id for this query to match syllabi assigned to course catalogs.

Parametersosid.id.IdcourseCatalogIda 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 an 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 query. 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.
MethodgetLessonQueryRecord
Description

Gets the lesson query record corresponding to the given Lesson record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypelessonRecordTypea lesson record type
Returnosid.course.plan.records.LessonQueryRecordthe lesson query record
ErrorsNULL_ARGUMENT lessonRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(lessonRecordType) is false
CompliancemandatoryThis method must be implemented.