OSID - osid.course.plan.LessonQuery Service Interface Definition

Interface	osid.course.plan.LessonQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.course.plan.LessonQuerySession`
	`osid.course.plan.LessonSearchSession`
	`osid.course.plan.LessonSmartCourseCatalogSession`
	`osid.course.plan.PlanQuery`
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` .
Method	matchPlanId
Description	Sets the plan `Id` for this query.
Parameters	`osid.id.Id`	`planId`	a plan `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`planId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPlanIdTerms
Description	Clears the plan `Id` tems.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanQuery
Description	Tests if a plan query is available.
Return	`boolean`		`true` if a plan query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPlanQuery
Description	Gets the query for a plan.
Return	`osid.course.plan.PlanQuery`		the plan query
Errors	UNIMPLEMENTED		`supportsPlanQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanQuery()` is `true` .
Method	clearPlanTerms
Description	Clears the plan terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDocetId
Description	Sets the docet `Id` for this query.
Parameters	`osid.id.Id`	`docetId`	a docet `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`docetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDocetIdTerms
Description	Clears the docet `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDocetQuery
Description	Tests if a docet query is available.
Return	`boolean`		`true` if a docet query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDocetQuery
Description	Gets the query for a docet.
Return	`osid.course.syllabus.DocetQuery`		the docet query
Errors	UNIMPLEMENTED		`supportsDocetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDocetQuery()` is `true` .
Method	matchAnyDocet
Description	Matches a lesson that has any docet.
Parameters	`boolean`	`match`	`true` to match lessons with any docet, `false` to match lessons with no docet
Compliance	`mandatory`		This method must be implemented.
Method	clearDocetTerms
Description	Clears the docet terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityId
Description	Sets the activity `Id` for this query.
Parameters	`osid.id.Id`	`activitytId`	an activity `Id`
Parameters	`boolean`	`match`	`true` for 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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if an activity query is available.
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.
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 a lesson that has any activity.
Parameters	`boolean`	`match`	`true` to match lessons with any activity, `false` to match lessons 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	matchPlannedStartTime
Description	Matches a planned start time within the given duration range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	a starting date
	`osid.calendaring.Duration`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPlannedStartTime
Description	Matches a lesson that has any planned start time.
Parameters	`boolean`	`match`	`true` to match lessons with any planned start time, `false` to match lessons with no planned start time
Compliance	`mandatory`		This method must be implemented.
Method	clearPlannedStartTimeTerms
Description	Clears the planned start time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActualStartTime
Description	Matches an actual start time within the given date range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	a starting date
	`osid.calendaring.Duration`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyActualStartTime
Description	Matches a lesson that has begun.
Parameters	`boolean`	`match`	`true` to match lessons with any actual start time, `false` to match lessons with no actual start time
Compliance	`mandatory`		This method must be implemented.
Method	clearActualStartTimeTerms
Description	Clears the actual start time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActualStartingActivityId
Description	Sets the starting activity `Id` for this query.
Parameters	`osid.id.Id`	`activitytId`	an activity `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActualStartingActivityIdTerms
Description	Clears the starting activity `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActualStartingActivityQuery
Description	Tests if a starting activity query is available.
Return	`boolean`		`true` if a starting activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartingActivityQuery
Description	Gets the query for a starting activity.
Return	`osid.course.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsActualStartingActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActualStartingActivityQuery()` is `true` .
Method	matchAnyActualStartingActivity
Description	Matches a lesson that has any starting activity.
Parameters	`boolean`	`match`	`true` to match lessons with any starting activity, `false` to match lessons with no starting activity
Compliance	`mandatory`		This method must be implemented.
Method	clearActualStartingActivityTerms
Description	Clears the starting activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchComplete
Description	Matches a lesson that has been completed.
Parameters	`boolean`	`match`	`true` to match lessons that have been completed, `false` to match lessons that have not been completed
Compliance	`mandatory`		This method must be implemented.
Method	clearCompleteTerms
Description	Clears the complete terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSkipped
Description	Matches a lesson that has been skipped.
Parameters	`boolean`	`match`	`true` to match lessons that have been skipped, `false` to match lessons that have not been skipped
Compliance	`mandatory`		This method must be implemented.
Method	clearSkippedTerms
Description	Clears the skipped terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActualEndTime
Description	Matches an actual ending time within the given date range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	a starting date
	`osid.calendaring.Duration`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyActualEndTime
Description	Matches a lesson that has any actual end time.
Parameters	`boolean`	`match`	`true` to match lessons with any actual end time, `false` to match lessons with no actual end time
Compliance	`mandatory`		This method must be implemented.
Method	clearActualEndTimeTerms
Description	Clears the actual end time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActualEndingActivityId
Description	Sets the ending activity `Id` for this query.
Parameters	`osid.id.Id`	`activitytId`	an activity `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActualEndingActivityIdTerms
Description	Clears the ending activity `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActualEndingActivityQuery
Description	Tests if an ending activity query is available.
Return	`boolean`		`true` if an ending activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndingActivityQuery
Description	Gets the query for an ending activity.
Return	`osid.course.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsEndingActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndingActivityQuery()` is `true` .
Method	matchAnyActualEndingActivity
Description	Matches a lesson that has any ending activity.
Parameters	`boolean`	`match`	`true` to match lessons with any ending activity, `false` to match lessons with no ending activity
Compliance	`mandatory`		This method must be implemented.
Method	clearActualEndingActivityTerms
Description	Clears the ending activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActualTimeSpent
Description	Matches an actual time spent within the given duration range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	a starting date
	`osid.calendaring.Duration`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyActualTimeSpent
Description	Matches a lesson that has any actual time spent.
Parameters	`boolean`	`match`	`true` to match lessons with any actual time spent, `false` to match lessons with no time spent
Compliance	`mandatory`		This method must be implemented.
Method	clearActualTimeSpentTerms
Description	Clears the actual time spent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the lesson `Id` for this query to match syllabi assigned to course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	a course catalog `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if an `CourseCatalogQuery` is available.
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 query. Multiple retrievals produce a nested `OR` term.
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	getLessonQueryRecord
Description	Gets the lesson query record corresponding to the given `Lesson` record `Type` .Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`lessonRecordType`	a lesson record type
Return	`osid.course.plan.records.LessonQueryRecord`		the lesson query record
Errors	NULL_ARGUMENT		`lessonRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(lessonRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.