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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested boolean OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsPlanQuery()} is {@code 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 {@code supportsDocetQuery()} is {@code 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 {@code supportsActivityQuery()} is {@code 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 - an 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 - an 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 {@code supportsActualStartingActivityQuery()} is {@code 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 - an 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 {@code supportsEndingActivityQuery()} is {@code 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 - an 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 {@code supportsCourseCatalogQuery()} is {@code 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.