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.

Like all OsidQueryInspectors, ProgramEntryQueryInspector is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • 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.

    • getParentProgramEntryIdTerms

      IdTerm[] getParentProgramEntryIdTerms()
      Gets the parent program entry Id query terms.
      Returns:
      the parent program entry Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getParentProgramEntryTerms

      ProgramEntryQueryInspector[] getParentProgramEntryTerms()
      Gets the parent program entry query terms.
      Returns:
      the parent program entry query terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsMatriculationKnownTerms

      BooleanTerm[] getIsMatriculationKnownTerms()
      Gets the matriculation known query terms.
      Returns:
      the matriculation known terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntranceDateTerms

      DateTimeRangeTerm[] getEntranceDateTerms()
      Gets the entrance date query terms.
      Returns:
      the entrance date terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntranceTermIdTerms

      IdTerm[] getEntranceTermIdTerms()
      Gets the entrance term Id query terms.
      Returns:
      the entrance term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntranceTermTerms

      TermQueryInspector[] getEntranceTermTerms()
      Gets the entrance term query terms.
      Returns:
      the entrance term terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsExpectedToCompleteTerms

      BooleanTerm[] getIsExpectedToCompleteTerms()
      Gets the expected to complete query terms.
      Returns:
      the expected to complete terms
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionDateTerms

      DateTimeRangeTerm[] getExpectedCompletionDateTerms()
      Gets the expected completion date query terms.
      Returns:
      the expected completion date terms
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermIdTerms

      IdTerm[] getExpectedCompletionTermIdTerms()
      Gets the expected completion term Id query terms.
      Returns:
      the expected completion term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermTerms

      TermQueryInspector[] getExpectedCompletionTermTerms()
      Gets the expected completion term query terms.
      Returns:
      the expected completion term terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsEnrolledTerms

      BooleanTerm[] getIsEnrolledTerms()
      Gets the enrolled query terms.
      Returns:
      the enrolled terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsActivelyEnrolledTerms

      BooleanTerm[] getIsActivelyEnrolledTerms()
      Gets the actively enrolled query terms.
      Returns:
      the actively enrolled terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsOnLeaveTerms

      BooleanTerm[] getIsOnLeaveTerms()
      Gets the on leave query terms.
      Returns:
      the on leave terms
      Compliance:
      mandatory - This method must be implemented.

    • getHasWithdrawnTerms

      BooleanTerm[] getHasWithdrawnTerms()
      Gets the withdrawn query terms.
      Returns:
      the withdrawn terms
      Compliance:
      mandatory - This method must be implemented.

    • getWithdrawDateTerms

      DateTimeRangeTerm[] getWithdrawDateTerms()
      Gets the withdraw date query terms.
      Returns:
      the withdraw date terms
      Compliance:
      mandatory - This method must be implemented.

    • getWithdrawTermIdTerms

      IdTerm[] getWithdrawTermIdTerms()
      Gets the withdraw term Id query terms.
      Returns:
      the withdraw term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWithdrawTermTerms

      TermQueryInspector[] getWithdrawTermTerms()
      Gets the withdraw term query terms.
      Returns:
      the withdraw term 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.

    • getCompletionDateTerms

      DateTimeRangeTerm[] getCompletionDateTerms()
      Gets the completion date query terms.
      Returns:
      the completion date terms
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionTermIdTerms

      IdTerm[] getCompletionTermIdTerms()
      Gets the completion term Id query terms.
      Returns:
      the completion term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionTermTerms

      TermQueryInspector[] getCompletionTermTerms()
      Gets the completion term query terms.
      Returns:
      the completion term terms
      Compliance:
      mandatory - This method must be implemented.

    • getLevelIdTerms

      IdTerm[] getLevelIdTerms()
      Gets the level Id query terms.
      Returns:
      the level Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getLevelTerms

      GradeQueryInspector[] getLevelTerms()
      Gets the level query terms.
      Returns:
      the level terms
      Compliance:
      mandatory - This method must be implemented.

    • getStandingIdTerms

      IdTerm[] getStandingIdTerms()
      Gets the standing Id query terms.
      Returns:
      the standing Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getStandingTerms

      GradeQueryInspector[] getStandingTerms()
      Gets the standing query terms.
      Returns:
      the standing 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.

    • 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.