OSID - osid.course.chronicle.ProgramEntryQueryInspector Service Interface Definition

Interface	osid.course.chronicle.ProgramEntryQueryInspector
Implements	`osid.OsidRelationshipQueryInspector`
Used By	`osid.course.chronicle.ProgramEntryQueryInspector`
	`osid.course.chronicle.ProgramEntrySearchResults`
	`osid.course.chronicle.ProgramEntrySmartCourseCatalogSession`
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	getStudentIdTerms
Description	Gets the resource `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 resource query terms
Compliance	`mandatory`		This method must be implemented.
Method	getProgramIdTerms
Description	Gets the program `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the program `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getProgramTerms
Description	Gets the program query terms.
Return	`osid.course.program.ProgramQueryInspector[]`		the program terms
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramEntryIdTerms
Description	Gets the parent program entry `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the parent program entry `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramEntryTerms
Description	Gets the parent program entry query terms.
Return	`osid.course.chronicle.ProgramEntryQueryInspector[]`		the parent program entry query terms
Compliance	`mandatory`		This method must be implemented.
Method	getIsMatriculationKnownTerms
Description	Gets the matriculation known query terms.
Return	`osid.search.terms.BooleanTerm[]`		the matriculation known terms
Compliance	`mandatory`		This method must be implemented.
Method	getEntranceDateTerms
Description	Gets the entrance date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the entrance date terms
Compliance	`mandatory`		This method must be implemented.
Method	getEntranceTermIdTerms
Description	Gets the entrance term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the entrance term `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEntranceTermTerms
Description	Gets the entrance term query terms.
Return	`osid.course.TermQueryInspector[]`		the entrance term terms
Compliance	`mandatory`		This method must be implemented.
Method	getIsExpectedToCompleteTerms
Description	Gets the expected to complete query terms.
Return	`osid.search.terms.BooleanTerm[]`		the expected to complete terms
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionDateTerms
Description	Gets the expected completion date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the expected completion date terms
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermIdTerms
Description	Gets the expected completion term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the expected completion term `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermTerms
Description	Gets the expected completion term query terms.
Return	`osid.course.TermQueryInspector[]`		the expected completion term terms
Compliance	`mandatory`		This method must be implemented.
Method	getIsEnrolledTerms
Description	Gets the enrolled query terms.
Return	`osid.search.terms.BooleanTerm[]`		the enrolled terms
Compliance	`mandatory`		This method must be implemented.
Method	getIsActivelyEnrolledTerms
Description	Gets the actively enrolled query terms.
Return	`osid.search.terms.BooleanTerm[]`		the actively enrolled terms
Compliance	`mandatory`		This method must be implemented.
Method	getIsOnLeaveTerms
Description	Gets the on leave query terms.
Return	`osid.search.terms.BooleanTerm[]`		the on leave terms
Compliance	`mandatory`		This method must be implemented.
Method	getHasWithdrawnTerms
Description	Gets the withdrawn query terms.
Return	`osid.search.terms.BooleanTerm[]`		the withdrawn terms
Compliance	`mandatory`		This method must be implemented.
Method	getWithdrawDateTerms
Description	Gets the withdraw date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the withdraw date terms
Compliance	`mandatory`		This method must be implemented.
Method	getWithdrawTermIdTerms
Description	Gets the withdraw term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the withdraw term `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getWithdrawTermTerms
Description	Gets the withdraw term query terms.
Return	`osid.course.TermQueryInspector[]`		the withdraw term terms
Compliance	`mandatory`		This method must be implemented.
Method	getCompleteTerms
Description	Gets the compledt program query terms.
Return	`osid.search.terms.BooleanTerm[]`		the completed course terms
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionDateTerms
Description	Gets the completion date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the completion date terms
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionTermIdTerms
Description	Gets the completion term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the completion term `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionTermTerms
Description	Gets the completion term query terms.
Return	`osid.course.TermQueryInspector[]`		the completion term terms
Compliance	`mandatory`		This method must be implemented.
Method	getLevelIdTerms
Description	Gets the level `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the level `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getLevelTerms
Description	Gets the level query terms.
Return	`osid.grading.GradeQueryInspector[]`		the level terms
Compliance	`mandatory`		This method must be implemented.
Method	getStandingIdTerms
Description	Gets the standing `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the standing `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStandingTerms
Description	Gets the standing query terms.
Return	`osid.grading.GradeQueryInspector[]`		the standing terms
Compliance	`mandatory`		This method must be implemented.
Method	getAdmissionDateTerms
Description	Gets the admission date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the date terms
Compliance	`mandatory`		This method must be implemented.
Method	getTermIdTerms
Description	Gets the term `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the term `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getTermTerms
Description	Gets the term query terms.
Return	`osid.course.TermQueryInspector[]`		the term terms
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleIdTerms
Description	Gets the grade system `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the grade system `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleTerms
Description	Gets the grade system query terms.
Return	`osid.grading.GradeSystemQueryInspector[]`		the grade system terms
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsEarnedTerms
Description	Gets the earned credits query terms.
Return	`osid.search.terms.DecimalRangeTerm[]`		the earned credits query terms
Compliance	`mandatory`		This method must be implemented.
Method	getGPAScaleIdTerms
Description	Gets the grade system `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the grade system `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getGPAScaleTerms
Description	Gets the grade system query terms.
Return	`osid.grading.GradeSystemQueryInspector[]`		the grade system terms
Compliance	`mandatory`		This method must be implemented.
Method	getGPATerms
Description	Gets the GPA query terms.
Return	`osid.search.terms.DecimalRangeTerm[]`		the GPA query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentIdTerms
Description	Gets the enrollment `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the enrollment `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentTerms
Description	Gets the enrollment query terms.
Return	`osid.course.program.EnrollmentQueryInspector[]`		the 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	getProgramEntryQueryInspectorRecord
Description	Gets the program entry query inspector record corresponding to the given `ProgramEntry` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`programEntryRecordType`	a program entry record type
Return	`osid.course.chronicle.records.ProgramEntryQueryInspectorRecord`		the program entry query inspector record
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.