OSID - osid.course.program.EnrollmentQueryInspector Service Interface Definition

Interface	osid.course.program.EnrollmentQueryInspector
Implements	`osid.OsidRelationshipQueryInspector`
Used By	`osid.course.chronicle.ProgramEntryQueryInspector`
	`osid.course.program.EnrollmentQueryInspector`
	`osid.course.program.EnrollmentSearchResults`
	`osid.course.program.EnrollmentSmartCourseCatalogSession`
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. Like all `OsidQueryInspectors`, `EnrollmentQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getProgramOfferingIdTerms
Description	Gets the program offering `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the program offering `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingTerms
Description	Gets the program offering query terms.
Return	`osid.course.program.ProgramOfferingQueryInspector[]`		the program offering query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStudentIdTerms
Description	Gets the student `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the resource `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStudentTerms
Description	Gets the student query terms.
Return	`osid.resource.ResourceQueryInspector[]`		the student query terms
Compliance	`mandatory`		This method must be implemented.
Method	getParentEnrollmentIdTerms
Description	Gets the parent enrollment `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the parent enrollment `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getParentEnrollmentTerms
Description	Gets the parent enrollment query terms.
Return	`osid.course.program.EnrollmentQueryInspector[]`		the parent enrollment 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	getEnrollmentQueryInspectorRecord
Description	Gets the enrollment query inspector record corresponding to the given `Enrollment` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`enrollmentRecordType`	an enrollment record type
Return	`osid.course.program.records.EnrollmentQueryInspectorRecord`		the enrollment query inspector record
Errors	NULL_ARGUMENT		`enrollmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(enrollmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.