org.osid.course.plan

Interface PlanQueryInspector

All Superinterfaces:

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

public interface PlanQueryInspector
extends OsidRelationshipQueryInspector

The inspector for examining plan queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog terms.
IdTerm[]	getCourseOfferingIdTerms() Gets the course offering Id terms.
CourseOfferingQueryInspector[]	getCourseOfferingTerms() Gets the course offering terms.
IdTerm[]	getLessonIdTerms() Gets the lesson Id terms.
LessonQueryInspector[]	getLessonTerms() Gets the lesson terms.
IdTerm[]	getModuleIdTerms() Gets the module Id terms.
ModuleQueryInspector[]	getModuleTerms() Gets the module terms.
PlanQueryInspectorRecord	getPlanQueryInspectorRecord(Type planRecordType) Gets the plan query inspector record corresponding to the given Plan record Type.
IdTerm[]	getSyllabusIdTerms() Gets the syllabus Id terms.
SyllabusQueryInspector[]	getSyllabusTerms() Gets the syllabus 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

getSyllabusIdTerms

IdTerm[] getSyllabusIdTerms()

Gets the syllabus Id terms.

Returns:

the syllabus Id terms

Compliance:

mandatory - This method must be implemented.

getSyllabusTerms

SyllabusQueryInspector[] getSyllabusTerms()

Gets the syllabus terms.

Returns:

the syllabus terms

Compliance:

mandatory - This method must be implemented.

getCourseOfferingIdTerms

IdTerm[] getCourseOfferingIdTerms()

Gets the course offering Id terms.

Returns:

the course offering Id terms

Compliance:

mandatory - This method must be implemented.

getCourseOfferingTerms

CourseOfferingQueryInspector[] getCourseOfferingTerms()

Gets the course offering terms.

Returns:

the course offering terms

Compliance:

mandatory - This method must be implemented.

getModuleIdTerms

IdTerm[] getModuleIdTerms()

Gets the module Id terms.

Returns:

the module Id terms

Compliance:

mandatory - This method must be implemented.

getModuleTerms

ModuleQueryInspector[] getModuleTerms()

Gets the module terms.

Returns:

the module terms

Compliance:

mandatory - This method must be implemented.

getLessonIdTerms

IdTerm[] getLessonIdTerms()

Gets the lesson Id terms.

Returns:

the lesson Id terms

Compliance:

mandatory - This method must be implemented.

getLessonTerms

LessonQueryInspector[] getLessonTerms()

Gets the lesson terms.

Returns:

the lesson 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.

getPlanQueryInspectorRecord

PlanQueryInspectorRecord getPlanQueryInspectorRecord(Type planRecordType)
                                                     throws OperationFailedException

Gets the plan query inspector record corresponding to the given Plan record Type.

Parameters:

planRecordType - a plan record type

Returns:

the plan query inspector record

Throws:

NullArgumentException - planRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planRecordType) is false

Compliance:

mandatory - This method must be implemented.