Interface EnrollmentQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
public interface EnrollmentQueryInspector 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 Details

    • getProgramOfferingIdTerms

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

    • getProgramOfferingTerms

      ProgramOfferingQueryInspector[] getProgramOfferingTerms()
      Gets the program offering query terms.
      Returns:
      the program offering query terms
      Compliance:
      mandatory - This method must be implemented.

    • getStudentIdTerms

      IdTerm[] getStudentIdTerms()
      Gets the student 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 student query terms
      Compliance:
      mandatory - This method must be implemented.

    • getParentEnrollmentIdTerms

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

    • getParentEnrollmentTerms

      EnrollmentQueryInspector[] getParentEnrollmentTerms()
      Gets the parent enrollment query terms.
      Returns:
      the parent 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.

    • getEnrollmentQueryInspectorRecord

      EnrollmentQueryInspectorRecord getEnrollmentQueryInspectorRecord(Type enrollmentRecordType) throws OperationFailedException
      Gets the enrollment query inspector record corresponding to the given Enrollment record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      enrollmentRecordType - an enrollment record type
      Returns:
      the enrollment query inspector record
      Throws:
      NullArgumentException - enrollmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(enrollmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.