org.osid.course.chronicle

Interface ProgramEntryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface ProgramEntryQueryInspector
extends OsidRelationshipQueryInspector

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[]	getAdmissionDateTerms() Gets the admission date query terms.
BooleanTerm[]	getCompleteTerms() Gets the compledt program query terms.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
IdTerm[]	getCreditScaleIdTerms() Gets the grade system Id query terms.
GradeSystemQueryInspector[]	getCreditScaleTerms() Gets the grade system query terms.
DecimalRangeTerm[]	getCreditsEarnedTerms() Gets the earned credits query terms.
IdTerm[]	getEnrollmentIdTerms() Gets the enrollment Id query terms.
EnrollmentQueryInspector[]	getEnrollmentTerms() Gets the enrollment query terms.
IdTerm[]	getGPAScaleIdTerms() Gets the grade system Id query terms.
GradeSystemQueryInspector[]	getGPAScaleTerms() Gets the grade system query terms.
DecimalRangeTerm[]	getGPATerms() Gets the GPA query terms.
ProgramEntryQueryInspectorRecord	getProgramEntryQueryInspectorRecord(Type programEntryRecordType) Gets the program entry query inspector record corresponding to the given ProgramEntry record Type.
IdTerm[]	getProgramIdTerms() Gets the program Id query terms.
ProgramQueryInspector[]	getProgramTerms() Gets the program query terms.
IdTerm[]	getStudentIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getStudentTerms() Gets the student query terms.
IdTerm[]	getTermIdTerms() Gets the term Id query terms.
TermQueryInspector[]	getTermTerms() Gets the term query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getStudentIdTerms

IdTerm[] getStudentIdTerms()

Gets the resource Id query terms.

Returns:

the resource Id query terms

Compliance:

mandatory - This method must be implemented.

getStudentTerms

ResourceQueryInspector[] getStudentTerms()

Gets the student query terms.

Returns:

the resource query terms

Compliance:

mandatory - This method must be implemented.

getProgramIdTerms

IdTerm[] getProgramIdTerms()

Gets the program Id query terms.

Returns:

the program Id query terms

Compliance:

mandatory - This method must be implemented.

getProgramTerms

ProgramQueryInspector[] getProgramTerms()

Gets the program query terms.

Returns:

the program terms

Compliance:

mandatory - This method must be implemented.

getAdmissionDateTerms

DateTimeRangeTerm[] getAdmissionDateTerms()

Gets the admission date query terms.

Returns:

the date terms

Compliance:

mandatory - This method must be implemented.

getCompleteTerms

BooleanTerm[] getCompleteTerms()

Gets the compledt program query terms.

Returns:

the completed course terms

Compliance:

mandatory - This method must be implemented.

getTermIdTerms

IdTerm[] getTermIdTerms()

Gets the term Id query terms.

Returns:

the term Id query terms

Compliance:

mandatory - This method must be implemented.

getTermTerms

TermQueryInspector[] getTermTerms()

Gets the term query terms.

Returns:

the term terms

Compliance:

mandatory - This method must be implemented.

getCreditScaleIdTerms

IdTerm[] getCreditScaleIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getCreditScaleTerms

GradeSystemQueryInspector[] getCreditScaleTerms()

Gets the grade system query terms.

Returns:

the grade system terms

Compliance:

mandatory - This method must be implemented.

getCreditsEarnedTerms

DecimalRangeTerm[] getCreditsEarnedTerms()

Gets the earned credits query terms.

Returns:

the earned credits query terms

Compliance:

mandatory - This method must be implemented.

getGPAScaleIdTerms

IdTerm[] getGPAScaleIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getGPAScaleTerms

GradeSystemQueryInspector[] getGPAScaleTerms()

Gets the grade system query terms.

Returns:

the grade system terms

Compliance:

mandatory - This method must be implemented.

getGPATerms

DecimalRangeTerm[] getGPATerms()

Gets the GPA query terms.

Returns:

the GPA query terms

Compliance:

mandatory - This method must be implemented.

getEnrollmentIdTerms

IdTerm[] getEnrollmentIdTerms()

Gets the enrollment Id query terms.

Returns:

the enrollment Id query terms

Compliance:

mandatory - This method must be implemented.

getEnrollmentTerms

EnrollmentQueryInspector[] getEnrollmentTerms()

Gets the enrollment query terms.

Returns:

the enrollment 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.

getProgramEntryQueryInspectorRecord

ProgramEntryQueryInspectorRecord getProgramEntryQueryInspectorRecord(Type programEntryRecordType)
                                                                     throws OperationFailedException

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

Parameters:

programEntryRecordType - a program entry record type

Returns:

the program entry query inspector record

Throws:

NullArgumentException - programEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.