org.osid.course

Interface CourseQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector

public interface CourseQueryInspector
extends OsidObjectQueryInspector, OsidOperableQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getActivityUnitIdTerms() Gets the activity unit Id query terms.
ActivityUnitQueryInspector[]	getActivityUnitTerms() Gets the activity unit query terms.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
IdTerm[]	getCourseOfferingIdTerms() Gets the course offering Id query terms.
CourseOfferingQueryInspector[]	getCourseOfferingTerms() Gets the course offering query terms.
CourseQueryInspectorRecord	getCourseQueryInspectorRecord(Type courseRecordType) Gets the course query inspector record corresponding to the given Course record Type.
IdTerm[]	getCreditAmountIdTerms() Gets the grade system Id query terms.
GradeQueryInspector[]	getCreditAmountTerms() Gets the grade system query terms.
IdTerm[]	getGradingOptionIdTerms() Gets the grade system Id query terms.
GradeSystemQueryInspector[]	getGradingOptionTerms() Gets the grade system query terms.
IdTerm[]	getLearningObjectiveIdTerms() Gets the objective Id query terms.
ObjectiveQueryInspector[]	getLearningObjectiveTerms() Gets the objective query terms.
IdTerm[]	getLevelIdTerms() Gets the grade level Id query terms.
GradeQueryInspector[]	getLevelTerms() Gets the grade level query terms.
StringTerm[]	getNumberTerms() Gets the bumber query terms.
IdTerm[]	getPrerequisitesIdTerms() Gets the requisite Id query terms.
StringTerm[]	getPrerequisitesInfoTerms() Gets the prerequisite query terms.
RequisiteQueryInspector[]	getPrerequisitesTerms() Gets the requisite query terms.
IdTerm[]	getSponsorIdTerms() Gets the sponsor Id query terms.
ResourceQueryInspector[]	getSponsorTerms() Gets the sponsor query terms.
StringTerm[]	getTitleTerms() Gets the title query terms.

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.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getTitleTerms

StringTerm[] getTitleTerms()

Gets the title query terms.

Returns:

the title query terms

Compliance:

mandatory - This method must be implemented.

getNumberTerms

StringTerm[] getNumberTerms()

Gets the bumber query terms.

Returns:

the number query terms

Compliance:

mandatory - This method must be implemented.

getSponsorIdTerms

IdTerm[] getSponsorIdTerms()

Gets the sponsor Id query terms.

Returns:

the sponsor Id query terms

Compliance:

mandatory - This method must be implemented.

getSponsorTerms

ResourceQueryInspector[] getSponsorTerms()

Gets the sponsor query terms.

Returns:

the sponsor query terms

Compliance:

mandatory - This method must be implemented.

getCreditAmountIdTerms

IdTerm[] getCreditAmountIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getCreditAmountTerms

GradeQueryInspector[] getCreditAmountTerms()

Gets the grade system query terms.

Returns:

the grade system query terms

Compliance:

mandatory - This method must be implemented.

getPrerequisitesInfoTerms

StringTerm[] getPrerequisitesInfoTerms()

Gets the prerequisite query terms.

Returns:

the prereq query terms

Compliance:

mandatory - This method must be implemented.

getPrerequisitesIdTerms

IdTerm[] getPrerequisitesIdTerms()

Gets the requisite Id query terms.

Returns:

the requisite Id query terms

Compliance:

mandatory - This method must be implemented.

getPrerequisitesTerms

RequisiteQueryInspector[] getPrerequisitesTerms()

Gets the requisite query terms.

Returns:

the requisite query terms

Compliance:

mandatory - This method must be implemented.

getLevelIdTerms

IdTerm[] getLevelIdTerms()

Gets the grade level Id query terms.

Returns:

the grade Id query terms

Compliance:

mandatory - This method must be implemented.

getLevelTerms

GradeQueryInspector[] getLevelTerms()

Gets the grade level query terms.

Returns:

the grade query terms

Compliance:

mandatory - This method must be implemented.

getGradingOptionIdTerms

IdTerm[] getGradingOptionIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getGradingOptionTerms

GradeSystemQueryInspector[] getGradingOptionTerms()

Gets the grade system query terms.

Returns:

the grade system terms

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveIdTerms

IdTerm[] getLearningObjectiveIdTerms()

Gets the objective Id query terms.

Returns:

the objective Id query terms

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveTerms

ObjectiveQueryInspector[] getLearningObjectiveTerms()

Gets the objective query terms.

Returns:

the objective query terms

Compliance:

mandatory - This method must be implemented.

getActivityUnitIdTerms

IdTerm[] getActivityUnitIdTerms()

Gets the activity unit Id query terms.

Returns:

the activity unit Id query terms

Compliance:

mandatory - This method must be implemented.

getActivityUnitTerms

ActivityUnitQueryInspector[] getActivityUnitTerms()

Gets the activity unit query terms.

Returns:

the activity unit query terms

Compliance:

mandatory - This method must be implemented.

getCourseOfferingIdTerms

IdTerm[] getCourseOfferingIdTerms()

Gets the course offering Id query terms.

Returns:

the course offering Id query terms

Compliance:

mandatory - This method must be implemented.

getCourseOfferingTerms

CourseOfferingQueryInspector[] getCourseOfferingTerms()

Gets the course offering query terms.

Returns:

the course offering query terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdTerms

IdTerm[] getCourseCatalogIdTerms()

Gets the course catalog Id query terms.

Returns:

the course catalog Id query terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogTerms

CourseCatalogQueryInspector[] getCourseCatalogTerms()

Gets the course catalog query terms.

Returns:

the course catalog query terms

Compliance:

mandatory - This method must be implemented.

getCourseQueryInspectorRecord

CourseQueryInspectorRecord getCourseQueryInspectorRecord(Type courseRecordType)
                                                         throws OperationFailedException

Gets the course query inspector record corresponding to the given Course record Type. Multiple record retrievals produce a nested OR term.

Parameters:

courseRecordType - a course record type

Returns:

the course query inspector record

Throws:

NullArgumentException - courseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseRecordType) is false

Compliance:

mandatory - This method must be implemented.