org.osid.course.plan

Interface LessonQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface LessonQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector 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
IdTerm[]	getActivityIdTerms() Gets the activity Id terms.
ActivityQueryInspector[]	getActivityTerms() Gets the activity terms.
IdTerm[]	getActualEndingActivityIdTerms() Gets the ending activity Id terms.
ActivityQueryInspector[]	getActualEndingActivityTerms() Gets the ending activity terms.
DurationRangeTerm[]	getActualEndTimeTerms() Gets the actual end time query terms.
IdTerm[]	getActualStartingActivityIdTerms() Gets the starting activity Id terms.
ActivityQueryInspector[]	getActualStartingActivityTerms() Gets the starting activity terms.
DurationRangeTerm[]	getActualStartTimeTerms() Gets actual start time query terms.
DurationRangeTerm[]	getActualTimeSpentTerms() Gets the actual time spent terms.
BooleanTerm[]	getCompleteTerms() Gets completed query terms.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog terms.
IdTerm[]	getDocetIdTerms() Gets the docet Id terms.
DocetQueryInspector[]	getDocetTerms() Gets the docet terms.
LessonQueryInspectorRecord	getLessonQueryInspectorRecord(Type lessonRecordType) Gets the query inspector record corresponding to the given Lesson record Type.
IdTerm[]	getPlanIdTerms() Gets the plan Id terms.
DurationRangeTerm[]	getPlannedStartTimeTerms() Gets the planned start time query terms.
PlanQueryInspector[]	getPlanTerms() Gets the plan terms.
BooleanTerm[]	getSkippedTerms() Gets skipped query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getPlanIdTerms

IdTerm[] getPlanIdTerms()

Gets the plan Id terms.

Returns:

the plan Id terms

Compliance:

mandatory - This method must be implemented.

getPlanTerms

PlanQueryInspector[] getPlanTerms()

Gets the plan terms.

Returns:

the plan terms

Compliance:

mandatory - This method must be implemented.

getDocetIdTerms

IdTerm[] getDocetIdTerms()

Gets the docet Id terms.

Returns:

the docet Id terms

Compliance:

mandatory - This method must be implemented.

getDocetTerms

DocetQueryInspector[] getDocetTerms()

Gets the docet terms.

Returns:

the docet terms

Compliance:

mandatory - This method must be implemented.

getActivityIdTerms

IdTerm[] getActivityIdTerms()

Gets the activity Id terms.

Returns:

the activity Id terms

Compliance:

mandatory - This method must be implemented.

getActivityTerms

ActivityQueryInspector[] getActivityTerms()

Gets the activity terms.

Returns:

the activity terms

Compliance:

mandatory - This method must be implemented.

getPlannedStartTimeTerms

DurationRangeTerm[] getPlannedStartTimeTerms()

Gets the planned start time query terms.

Returns:

the time terms

Compliance:

mandatory - This method must be implemented.

getActualStartTimeTerms

DurationRangeTerm[] getActualStartTimeTerms()

Gets actual start time query terms.

Returns:

the terms

Compliance:

mandatory - This method must be implemented.

getActualStartingActivityIdTerms

IdTerm[] getActualStartingActivityIdTerms()

Gets the starting activity Id terms.

Returns:

the activity Id terms

Compliance:

mandatory - This method must be implemented.

getActualStartingActivityTerms

ActivityQueryInspector[] getActualStartingActivityTerms()

Gets the starting activity terms.

Returns:

the activity terms

Compliance:

mandatory - This method must be implemented.

getCompleteTerms

BooleanTerm[] getCompleteTerms()

Gets completed query terms.

Returns:

the terms

Compliance:

mandatory - This method must be implemented.

getSkippedTerms

BooleanTerm[] getSkippedTerms()

Gets skipped query terms.

Returns:

the terms

Compliance:

mandatory - This method must be implemented.

getActualEndTimeTerms

DurationRangeTerm[] getActualEndTimeTerms()

Gets the actual end time query terms.

Returns:

the time time terms

Compliance:

mandatory - This method must be implemented.

getActualEndingActivityIdTerms

IdTerm[] getActualEndingActivityIdTerms()

Gets the ending activity Id terms.

Returns:

the activity Id terms

Compliance:

mandatory - This method must be implemented.

getActualEndingActivityTerms

ActivityQueryInspector[] getActualEndingActivityTerms()

Gets the ending activity terms.

Returns:

the activity terms

Compliance:

mandatory - This method must be implemented.

getActualTimeSpentTerms

DurationRangeTerm[] getActualTimeSpentTerms()

Gets the actual time spent terms.

Returns:

the duration terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdTerms

IdTerm[] getCourseCatalogIdTerms()

Gets the course catalog Id terms.

Returns:

the course catalog Id terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogTerms

CourseCatalogQueryInspector[] getCourseCatalogTerms()

Gets the course catalog terms.

Returns:

the course catalog terms

Compliance:

mandatory - This method must be implemented.

getLessonQueryInspectorRecord

LessonQueryInspectorRecord getLessonQueryInspectorRecord(Type lessonRecordType)
                                                         throws OperationFailedException

Gets the query inspector record corresponding to the given Lesson record Type.

Parameters:

lessonRecordType - a lesson record type

Returns:

the lesson query inspector record

Throws:

NullArgumentException - lessonRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(lessonRecordType) is false

Compliance:

mandatory - This method must be implemented.