OSID - osid.course.TermQuery Service Interface Definition

Interface	osid.course.TermQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidFederateableQuery`
Description	This is the query for searching terms. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchDisplayLabel
Description	Adds a display label for this query.
Parameters	`string`	`label`	label string to match
	`osid.type.Type`	`stringMatchType`	the label match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`label` not of `stringMatchType`
	NULL_ARGUMENT		`label` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDisplayLabel
Description	Matches a display label that has any value.
Parameters	`boolean`	`match`	`true` to match courses with any label, `false` to match assets with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearDisplayLabelTerms
Description	Clears the display label query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOpenDate
Description	Matches the open date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOpenDate
Description	Matches a term that has any open date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any open date, `false` to match terms with no open date
Compliance	`mandatory`		This method must be implemented.
Method	clearOpenDateTerms
Description	Clears the open date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRegistrationStart
Description	Matches the registration start date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRegistrationStart
Description	Matches a term that has any registration start date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any registration start date, `false` to match terms with no registration start date
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationStartTerms
Description	Clears the registration start date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRegistrationEnd
Description	Matches the registration end date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRegistrationEnd
Description	Matches a term that has any registration end date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any registration end date, `false` to match terms with no registration end date
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationEndTerms
Description	Clears the registration end date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRegistrationPeriod
Description	Matches the registration period that incudes the given date.
Parameters	`osid.calendaring.DateTime`	`date`	a date
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationPeriodTerms
Description	Clears the registration period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRegistrationDuration
Description	Matches the registration period duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	low duration range
	`osid.calendaring.Duration`	`high`	high duration range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationDurationTerms
Description	Clears the registration period duration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchClassesStart
Description	Matches the class start date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyClassesStart
Description	Matches a term that has any class start date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any class start date, `false` to match terms with no class start date
Compliance	`mandatory`		This method must be implemented.
Method	clearClassesStartTerms
Description	Clears the class start date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchClassesEnd
Description	Matches the class end date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyClassesEnd
Description	Matches a term that has any class end date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any class end date, `false` to match terms with no class end date
Compliance	`mandatory`		This method must be implemented.
Method	clearClassesEndTerms
Description	Clears the class end date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchClassesPeriod
Description	Matches the class period that incudes the given date.
Parameters	`osid.calendaring.DateTime`	`date`	a date
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearClassesPeriodTerms
Description	Clears the class period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchClassesDuration
Description	Matches the classes period duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	low duration range
	`osid.calendaring.Duration`	`high`	high duration range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	clearClassesDurationTerms
Description	Clears the classes period duration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAddDate
Description	Matches the add date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAddDate
Description	Matches a term that has any add date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any add date, `false` to match terms with no add/drop date
Compliance	`mandatory`		This method must be implemented.
Method	clearAddDateTerms
Description	Clears the add date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDropDate
Description	Matches the drop date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDropDate
Description	Matches a term that has any drop date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any drop date, `false` to match terms with no add/drop date
Compliance	`mandatory`		This method must be implemented.
Method	clearDropDateTerms
Description	Clears the drop date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFinalExamStart
Description	Matches the final exam period start date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFinalExamStart
Description	Matches a term that has any final exam period start date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any final exam start date, `false` to match terms with no final exam start date
Compliance	`mandatory`		This method must be implemented.
Method	clearFinalExamStartTerms
Description	Clears the final exam start date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFinalExamEnd
Description	Matches the final exam period end date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFinalExamEnd
Description	Matches a term that has any final exam period end date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any final exam end date, `false` to match terms with no final exam end date
Compliance	`mandatory`		This method must be implemented.
Method	clearFinalExamEndTerms
Description	Clears the final exam period end date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFinalExamPeriod
Description	Matches the final exam period that incudes the given date.
Parameters	`osid.calendaring.DateTime`	`date`	a date
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFinalExamPeriodTerms
Description	Clears the final exam period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFinalExamDuration
Description	Matches the final exam period duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	low duration range
	`osid.calendaring.Duration`	`high`	high duration range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	clearFinalExamDurationTerms
Description	Clears the final exam period duration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCloseDate
Description	Matches the close date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low date range
	`osid.calendaring.DateTime`	`high`	high date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCloseDate
Description	Matches a term that has any close date assigned.
Parameters	`boolean`	`match`	`true` to match terms with any close date, `false` to match terms with no close date
Compliance	`mandatory`		This method must be implemented.
Method	clearCloseDateTerms
Description	Clears the close date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorTermId
Description	Sets the term `Id` for this query to match terms that have the specified term as an ancestor.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`termId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorTermIdTerms
Description	Clears the ancestor term `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a termency query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorTermQuery
Description	Gets the query for a term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		the term query
Errors	UNIMPLEMENTED		`supportsAncestorTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorTermQuery()` is `true.`
Method	matchAnyAncestorTerm
Description	Matches terms with any ancestor.
Parameters	`boolean`	`match`	`true` to match terms with any ancestor, `false` to match root terms
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorTermTerms
Description	Clears the ancestor term query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantTermId
Description	Sets the term `Id` for this query to match terms that have the specified term as a descendant.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`termId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantTermIdTerms
Description	Clears the descendant term `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a termency query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantTermQuery
Description	Gets the query for a term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		the term query
Errors	UNIMPLEMENTED		`supportsDescendantTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantTermQuery()` is `true.`
Method	matchAnyDescendantTerm
Description	Matches terms with any descendant.
Parameters	`boolean`	`match`	`true` to match terms with any Ddscendant, `false` to match leaf terms
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantTermTerms
Description	Clears the descendant term query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseOfferingId
Description	Sets the course offering `Id` for this query to match terms assigned to course offerings.
Parameters	`osid.id.Id`	`courseOfferingId`	the course offering `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseOfferingIdTerms
Description	Clears the course offering `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingQuery
Description	Tests if a `CourseOfferingQuery` is available.
Return	`boolean`		`true` if a course offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingQuery
Description	Gets the query for a course offering. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseOfferingQuery`		the course offering query
Errors	UNIMPLEMENTED		`supportsCourseOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseOfferingQuery()` is `true.`
Method	matchAnyCourseOffering
Description	Matches courses that have any course offering.
Parameters	`boolean`	`match`	`true` to match terms with any course offering, `false` to match terms with no course offerings
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseOfferingTerms
Description	Clears the course offering query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match terms assigned to course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	the course catalog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseCatalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseCatalogIdTerms
Description	Clears the course catalog `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if a `CourseCatalogQuery` is available.
Return	`boolean`		`true` if a course catalog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogQuery
Description	Gets the query for a course catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseCatalogQuery`		the course catalog query
Errors	UNIMPLEMENTED		`supportsCourseCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseCatalogQuery()` is `true.`
Method	clearCourseCatalogTerms
Description	Clears the course catalog query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getTermQueryRecord
Description	Gets the term query 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.TermQueryRecord`		the term query 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.