org.osid.course

Interface TermQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface TermQueryInspector
extends OsidObjectQueryInspector, OsidFederateableQueryInspector

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
DateTimeRangeTerm[]	getAddDateTerms() Gets the add date query terms.
IdTerm[]	getAncestorTermIdTerms() Gets the ancestor term Id query terms.
TermQueryInspector[]	getAncestorTermTerms() Gets the ancestor term query terms.
DurationRangeTerm[]	getClassesDurationTerms() Gets the classes duration query terms.
DateTimeRangeTerm[]	getClassesEndTerms() Gets the class end date query terms.
DateTimeRangeTerm[]	getClassesPeriodTerms() Gets the class period query terms.
DateTimeRangeTerm[]	getClassesStartTerms() Gets the class start date query terms.
DateTimeRangeTerm[]	getCloseDateTerms() Gets the close date 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.
IdTerm[]	getDescendantTermIdTerms() Gets the descendant term Id query terms.
TermQueryInspector[]	getDescendantTermTerms() Gets the descendant term query terms.
StringTerm[]	getDisplayLabelTerms() Gets the display label query terms.
DateTimeRangeTerm[]	getDropDateTerms() Gets the drop date query terms.
DurationRangeTerm[]	getFinalExamDurationTerms() Gets the final exam duration query terms.
DateTimeRangeTerm[]	getFinalExamEndTerms() Gets the final exam end date query terms.
DateTimeRangeTerm[]	getFinalExamPeriodTerms() Gets the final exam period query terms.
DateTimeRangeTerm[]	getFinalExamStartTerms() Gets the final exam start date query terms.
DateTimeRangeTerm[]	getOpenDateTerms() Gets the open date query terms.
DurationRangeTerm[]	getRegistrationDurationTerms() Gets the registration duration query terms.
DateTimeRangeTerm[]	getRegistrationEndTerms() Gets the registration end date query terms.
DateTimeRangeTerm[]	getRegistrationPeriodTerms() Gets the registration period query terms.
DateTimeRangeTerm[]	getRegistrationStartTerms() Gets the registration start date query terms.
TermQueryInspectorRecord	getTermQueryInspectorRecord(Type termRecordType) Gets the term query inspector record corresponding to the given Term record Type.

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

Method Detail

getDisplayLabelTerms

StringTerm[] getDisplayLabelTerms()

Gets the display label query terms.

Returns:

the display labelquery terms

Compliance:

mandatory - This method must be implemented.

getOpenDateTerms

DateTimeRangeTerm[] getOpenDateTerms()

Gets the open date query terms.

Returns:

the open date query terms

Compliance:

mandatory - This method must be implemented.

getRegistrationStartTerms

DateTimeRangeTerm[] getRegistrationStartTerms()

Gets the registration start date query terms.

Returns:

the registration start date query terms

Compliance:

mandatory - This method must be implemented.

getRegistrationEndTerms

DateTimeRangeTerm[] getRegistrationEndTerms()

Gets the registration end date query terms.

Returns:

the registration end date query terms

Compliance:

mandatory - This method must be implemented.

getRegistrationPeriodTerms

DateTimeRangeTerm[] getRegistrationPeriodTerms()

Gets the registration period query terms.

Returns:

the registration period query terms

Compliance:

mandatory - This method must be implemented.

getRegistrationDurationTerms

DurationRangeTerm[] getRegistrationDurationTerms()

Gets the registration duration query terms.

Returns:

the registration duration query terms

Compliance:

mandatory - This method must be implemented.

getClassesStartTerms

DateTimeRangeTerm[] getClassesStartTerms()

Gets the class start date query terms.

Returns:

the class start date query terms

Compliance:

mandatory - This method must be implemented.

getClassesEndTerms

DateTimeRangeTerm[] getClassesEndTerms()

Gets the class end date query terms.

Returns:

the class end date query terms

Compliance:

mandatory - This method must be implemented.

getClassesPeriodTerms

DateTimeRangeTerm[] getClassesPeriodTerms()

Gets the class period query terms.

Returns:

the class period query terms

Compliance:

mandatory - This method must be implemented.

getClassesDurationTerms

DurationRangeTerm[] getClassesDurationTerms()

Gets the classes duration query terms.

Returns:

the classes duration query terms

Compliance:

mandatory - This method must be implemented.

getAddDateTerms

DateTimeRangeTerm[] getAddDateTerms()

Gets the add date query terms.

Returns:

the add date query terms

Compliance:

mandatory - This method must be implemented.

getDropDateTerms

DateTimeRangeTerm[] getDropDateTerms()

Gets the drop date query terms.

Returns:

the drop date query terms

Compliance:

mandatory - This method must be implemented.

getFinalExamStartTerms

DateTimeRangeTerm[] getFinalExamStartTerms()

Gets the final exam start date query terms.

Returns:

the final exam start date query terms

Compliance:

mandatory - This method must be implemented.

getFinalExamEndTerms

DateTimeRangeTerm[] getFinalExamEndTerms()

Gets the final exam end date query terms.

Returns:

the final exam end date query terms

Compliance:

mandatory - This method must be implemented.

getFinalExamPeriodTerms

DateTimeRangeTerm[] getFinalExamPeriodTerms()

Gets the final exam period query terms.

Returns:

the final exam period query terms

Compliance:

mandatory - This method must be implemented.

getFinalExamDurationTerms

DurationRangeTerm[] getFinalExamDurationTerms()

Gets the final exam duration query terms.

Returns:

the final exam duration query terms

Compliance:

mandatory - This method must be implemented.

getCloseDateTerms

DateTimeRangeTerm[] getCloseDateTerms()

Gets the close date query terms.

Returns:

the close date query terms

Compliance:

mandatory - This method must be implemented.

getAncestorTermIdTerms

IdTerm[] getAncestorTermIdTerms()

Gets the ancestor term Id query terms.

Returns:

the ancestor term Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorTermTerms

TermQueryInspector[] getAncestorTermTerms()

Gets the ancestor term query terms.

Returns:

the ancestor term terms

Compliance:

mandatory - This method must be implemented.

getDescendantTermIdTerms

IdTerm[] getDescendantTermIdTerms()

Gets the descendant term Id query terms.

Returns:

the descendant term Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantTermTerms

TermQueryInspector[] getDescendantTermTerms()

Gets the descendant term query terms.

Returns:

the descendant term 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.

getTermQueryInspectorRecord

TermQueryInspectorRecord getTermQueryInspectorRecord(Type termRecordType)
                                                     throws OperationFailedException

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

Parameters:

termRecordType - a term record type

Returns:

the term query inspector record

Throws:

NullArgumentException - termRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(termRecordType) is false

Compliance:

mandatory - This method must be implemented.