OSID - osid.course.TermQueryInspector Service Interface Definition

Interface	osid.course.TermQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Implements	`osid.OsidFederateableQueryInspector`
Used By	`osid.course.ActivityQueryInspector`
	`osid.course.CourseCatalogQueryInspector`
	`osid.course.CourseOfferingQueryInspector`
	`osid.course.TermQueryInspector`
	`osid.course.TermSearchResults`
	`osid.course.TermSmartCourseCatalogSession`
	`osid.course.chronicle.CourseEntryQueryInspector`
	`osid.course.chronicle.CredentialEntryQueryInspector`
	`osid.course.chronicle.ProgramEntryQueryInspector`
	`osid.course.program.ProgramOfferingQueryInspector`
	show 1 more…
`osid.course.registration.request.RegistrationRequestQueryInspector`
Description	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	getDisplayLabelTerms
Description	Gets the display label query terms.
Return	`osid.search.terms.StringTerm[]`		the display labelquery terms
Compliance	`mandatory`		This method must be implemented.
Method	getOpenDateTerms
Description	Gets the open date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the open date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationStartTerms
Description	Gets the registration start date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the registration start date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationEndTerms
Description	Gets the registration end date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the registration end date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationPeriodTerms
Description	Gets the registration period query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the registration period query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationDurationTerms
Description	Gets the registration duration query terms.
Return	`osid.search.terms.DurationRangeTerm[]`		the registration duration query terms
Compliance	`mandatory`		This method must be implemented.
Method	getClassesStartTerms
Description	Gets the class start date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the class start date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getClassesEndTerms
Description	Gets the class end date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the class end date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getClassesPeriodTerms
Description	Gets the class period query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the class period query terms
Compliance	`mandatory`		This method must be implemented.
Method	getClassesDurationTerms
Description	Gets the classes duration query terms.
Return	`osid.search.terms.DurationRangeTerm[]`		the classes duration query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAddDateTerms
Description	Gets the add date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the add date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDropDateTerms
Description	Gets the drop date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the drop date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getFinalExamStartTerms
Description	Gets the final exam start date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the final exam start date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getFinalExamEndTerms
Description	Gets the final exam end date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the final exam end date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getFinalExamPeriodTerms
Description	Gets the final exam period query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the final exam period query terms
Compliance	`mandatory`		This method must be implemented.
Method	getFinalExamDurationTerms
Description	Gets the final exam duration query terms.
Return	`osid.search.terms.DurationRangeTerm[]`		the final exam duration query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCloseDateTerms
Description	Gets the close date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the close date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorTermIdTerms
Description	Gets the ancestor term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the ancestor term `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorTermTerms
Description	Gets the ancestor term query terms.
Return	`osid.course.TermQueryInspector[]`		the ancestor term terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantTermIdTerms
Description	Gets the descendant term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the descendant term `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantTermTerms
Description	Gets the descendant term query terms.
Return	`osid.course.TermQueryInspector[]`		the descendant term terms
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingIdTerms
Description	Gets the course offering `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the course offering `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingTerms
Description	Gets the course offering query terms.
Return	`osid.course.CourseOfferingQueryInspector[]`		the course offering query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogIdTerms
Description	Gets the course catalog `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the course catalog `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogTerms
Description	Gets the course catalog query terms.
Return	`osid.course.CourseCatalogQueryInspector[]`		the course catalog query terms
Compliance	`mandatory`		This method must be implemented.
Method	getTermQueryInspectorRecord
Description	Gets the term query inspector record corresponding to the given `Term` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`termRecordType`	a term record type
Return	`osid.course.records.TermQueryInspectorRecord`		the term query inspector record
Errors	NULL_ARGUMENT		`termRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(termRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.