org.osid.course.plan

Interface LessonQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface LessonQuery
extends OsidRelationshipQuery

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 Summary

Methods

Modifier and Type	Method and Description
void	clearActivityIdTerms() Clears the activity Id terms.
void	clearActivityTerms() Clears the activity terms.
void	clearActualEndingActivityIdTerms() Clears the ending activity Id terms.
void	clearActualEndingActivityTerms() Clears the ending activity terms.
void	clearActualEndTimeTerms() Clears the actual end time terms.
void	clearActualStartingActivityIdTerms() Clears the starting activity Id terms.
void	clearActualStartingActivityTerms() Clears the starting activity terms.
void	clearActualStartTimeTerms() Clears the actual start time terms.
void	clearActualTimeSpentTerms() Clears the actual time spent terms.
void	clearCompleteTerms() Clears the complete terms.
void	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearDocetIdTerms() Clears the docet Id terms.
void	clearDocetTerms() Clears the docet terms.
void	clearPlanIdTerms() Clears the plan Id tems.
void	clearPlannedStartTimeTerms() Clears the planned start time terms.
void	clearPlanTerms() Clears the plan terms.
void	clearSkippedTerms() Clears the skipped terms.
ActivityQuery	getActivityQuery() Gets the query for an activity.
ActivityQuery	getActualEndingActivityQuery() Gets the query for an ending activity.
ActivityQuery	getActualStartingActivityQuery() Gets the query for a starting activity.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog query.
DocetQuery	getDocetQuery() Gets the query for a docet.
LessonQueryRecord	getLessonQueryRecord(Type lessonRecordType) Gets the lesson query record corresponding to the given Lesson record Type.
PlanQuery	getPlanQuery() Gets the query for a plan.
void	matchActivityId(Id activitytId, boolean match) Sets the activity Id for this query.
void	matchActualEndingActivityId(Id activitytId, boolean match) Sets the ending activity Id for this query.
void	matchActualEndTime(Duration from, Duration to, boolean match) Matches an actual ending time within the given date range inclusive.
void	matchActualStartingActivityId(Id activitytId, boolean match) Sets the starting activity Id for this query.
void	matchActualStartTime(Duration from, Duration to, boolean match) Matches an actual start time within the given date range inclusive.
void	matchActualTimeSpent(Duration from, Duration to, boolean match) Matches an actual time spent within the given duration range inclusive.
void	matchAnyActivity(boolean match) Matches a lesson that has any activity.
void	matchAnyActualEndingActivity(boolean match) Matches a lesson that has any ending activity.
void	matchAnyActualEndTime(boolean match) Matches a lesson that has any actual end time.
void	matchAnyActualStartingActivity(boolean match) Matches a lesson that has any starting activity.
void	matchAnyActualStartTime(boolean match) Matches a lesson that has begun.
void	matchAnyActualTimeSpent(boolean match) Matches a lesson that has any actual time spent.
void	matchAnyDocet(boolean match) Matches a lesson that has any docet.
void	matchAnyPlannedStartTime(boolean match) Matches a lesson that has any planned start time.
void	matchComplete(boolean match) Matches a lesson that has been completed.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the lesson Id for this query to match syllabi assigned to course catalogs.
void	matchDocetId(Id docetId, boolean match) Sets the docet Id for this query.
void	matchPlanId(Id planId, boolean match) Sets the plan Id for this query.
void	matchPlannedStartTime(Duration from, Duration to, boolean match) Matches a planned start time within the given duration range inclusive.
void	matchSkipped(boolean match) Matches a lesson that has been skipped.
boolean	supportsActivityQuery() Tests if an activity query is available.
boolean	supportsActualEndingActivityQuery() Tests if an ending activity query is available.
boolean	supportsActualStartingActivityQuery() Tests if a starting activity query is available.
boolean	supportsCourseCatalogQuery() Tests if an CourseCatalogQuery is available.
boolean	supportsDocetQuery() Tests if a docet query is available.
boolean	supportsPlanQuery() Tests if a plan query is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchPlanId

void matchPlanId(Id planId,
               boolean match)

Sets the plan Id for this query.

Parameters:

planId - a plan Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - planId is null

Compliance:

mandatory - This method must be implemented.

clearPlanIdTerms

void clearPlanIdTerms()

Clears the plan Id tems.

Compliance:

mandatory - This method must be implemented.

supportsPlanQuery

boolean supportsPlanQuery()

Tests if a plan query is available.

Returns:

true if a plan query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPlanQuery

PlanQuery getPlanQuery()

Gets the query for a plan.

Returns:

the plan query

Throws:

UnimplementedException - supportsPlanQuery() is false

Compliance:

optional - This method must be implemented if supportsPlanQuery() is true.

clearPlanTerms

void clearPlanTerms()

Clears the plan terms.

Compliance:

mandatory - This method must be implemented.

matchDocetId

void matchDocetId(Id docetId,
                boolean match)

Sets the docet Id for this query.

Parameters:

docetId - a docet Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - docetId is null

Compliance:

mandatory - This method must be implemented.

clearDocetIdTerms

void clearDocetIdTerms()

Clears the docet Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDocetQuery

boolean supportsDocetQuery()

Tests if a docet query is available.

Returns:

true if a docet query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDocetQuery

DocetQuery getDocetQuery()

Gets the query for a docet.

Returns:

the docet query

Throws:

UnimplementedException - supportsDocetQuery() is false

Compliance:

optional - This method must be implemented if supportsDocetQuery() is true.

matchAnyDocet

void matchAnyDocet(boolean match)

Matches a lesson that has any docet.

Parameters:

match - true to match lessons with any docet, false to match lessons with no docet

Compliance:

mandatory - This method must be implemented.

clearDocetTerms

void clearDocetTerms()

Clears the docet terms.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activitytId,
                   boolean match)

Sets the activity Id for this query.

Parameters:

activitytId - an activity Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an activity query is available.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

Gets the query for an activity.

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() is true.

matchAnyActivity

void matchAnyActivity(boolean match)

Matches a lesson that has any activity.

Parameters:

match - true to match lessons with any activity, false to match lessons with no activities

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchPlannedStartTime

void matchPlannedStartTime(Duration from,
                         Duration to,
                         boolean match)

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

Parameters:

from - a starting date

to - a ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyPlannedStartTime

void matchAnyPlannedStartTime(boolean match)

Matches a lesson that has any planned start time.

Parameters:

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.

clearPlannedStartTimeTerms

void clearPlannedStartTimeTerms()

Clears the planned start time terms.

Compliance:

mandatory - This method must be implemented.

matchActualStartTime

void matchActualStartTime(Duration from,
                        Duration to,
                        boolean match)

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

Parameters:

from - a starting date

to - a ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyActualStartTime

void matchAnyActualStartTime(boolean match)

Matches a lesson that has begun.

Parameters:

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.

clearActualStartTimeTerms

void clearActualStartTimeTerms()

Clears the actual start time terms.

Compliance:

mandatory - This method must be implemented.

matchActualStartingActivityId

void matchActualStartingActivityId(Id activitytId,
                                 boolean match)

Sets the starting activity Id for this query.

Parameters:

activitytId - an activity Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActualStartingActivityIdTerms

void clearActualStartingActivityIdTerms()

Clears the starting activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActualStartingActivityQuery

boolean supportsActualStartingActivityQuery()

Tests if a starting activity query is available.

Returns:

true if a starting activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActualStartingActivityQuery

ActivityQuery getActualStartingActivityQuery()

Gets the query for a starting activity.

Returns:

the activity query

Throws:

UnimplementedException - supportsActualStartingActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActualStartingActivityQuery() is true.

matchAnyActualStartingActivity

void matchAnyActualStartingActivity(boolean match)

Matches a lesson that has any starting activity.

Parameters:

match - true to match lessons with any starting activity, false to match lessons with no starting activity

Compliance:

mandatory - This method must be implemented.

clearActualStartingActivityTerms

void clearActualStartingActivityTerms()

Clears the starting activity terms.

Compliance:

mandatory - This method must be implemented.

matchComplete

void matchComplete(boolean match)

Matches a lesson that has been completed.

Parameters:

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.

clearCompleteTerms

void clearCompleteTerms()

Clears the complete terms.

Compliance:

mandatory - This method must be implemented.

matchSkipped

void matchSkipped(boolean match)

Matches a lesson that has been skipped.

Parameters:

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.

clearSkippedTerms

void clearSkippedTerms()

Clears the skipped terms.

Compliance:

mandatory - This method must be implemented.

matchActualEndTime

void matchActualEndTime(Duration from,
                      Duration to,
                      boolean match)

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

Parameters:

from - a starting date

to - a ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyActualEndTime

void matchAnyActualEndTime(boolean match)

Matches a lesson that has any actual end time.

Parameters:

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.

clearActualEndTimeTerms

void clearActualEndTimeTerms()

Clears the actual end time terms.

Compliance:

mandatory - This method must be implemented.

matchActualEndingActivityId

void matchActualEndingActivityId(Id activitytId,
                               boolean match)

Sets the ending activity Id for this query.

Parameters:

activitytId - an activity Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActualEndingActivityIdTerms

void clearActualEndingActivityIdTerms()

Clears the ending activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActualEndingActivityQuery

boolean supportsActualEndingActivityQuery()

Tests if an ending activity query is available.

Returns:

true if an ending activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActualEndingActivityQuery

ActivityQuery getActualEndingActivityQuery()

Gets the query for an ending activity.

Returns:

the activity query

Throws:

UnimplementedException - supportsEndingActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsEndingActivityQuery() is true.

matchAnyActualEndingActivity

void matchAnyActualEndingActivity(boolean match)

Matches a lesson that has any ending activity.

Parameters:

match - true to match lessons with any ending activity, false to match lessons with no ending activity

Compliance:

mandatory - This method must be implemented.

clearActualEndingActivityTerms

void clearActualEndingActivityTerms()

Clears the ending activity terms.

Compliance:

mandatory - This method must be implemented.

matchActualTimeSpent

void matchActualTimeSpent(Duration from,
                        Duration to,
                        boolean match)

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

Parameters:

from - a starting date

to - a ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyActualTimeSpent

void matchAnyActualTimeSpent(boolean match)

Matches a lesson that has any actual time spent.

Parameters:

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.

clearActualTimeSpentTerms

void clearActualTimeSpentTerms()

Clears the actual time spent terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

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

Parameters:

courseCatalogId - a course catalog Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

clearCourseCatalogIdTerms

void clearCourseCatalogIdTerms()

Clears the course catalog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseCatalogQuery

boolean supportsCourseCatalogQuery()

Tests if an CourseCatalogQuery is available.

Returns:

true if a course catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQuery

CourseCatalogQuery getCourseCatalogQuery()

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

Returns:

the course catalog query

Throws:

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

optional - This method must be implemented if supportsCourseCatalogQuery() is true.

clearCourseCatalogTerms

void clearCourseCatalogTerms()

Clears the course catalog terms.

Compliance:

mandatory - This method must be implemented.

getLessonQueryRecord

LessonQueryRecord getLessonQueryRecord(Type lessonRecordType)
                                       throws OperationFailedException

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

Parameters:

lessonRecordType - a lesson record type

Returns:

the lesson query record

Throws:

NullArgumentException - lessonRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(lessonRecordType) is false

Compliance:

mandatory - This method must be implemented.