Interface RegistrationQueryInspector

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

    • getCourseRegistrationIdTerms

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

    • getCourseRegistrationTerms

      CourseRegistrationQueryInspector[] getCourseRegistrationTerms()
      Gets the course registration query terms.
      Returns:
      the course registration query terms
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetQueryIdTerms

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

    • getRegistrationTargetQueryTerms

      RegistrationTargetQueryInspector[] getRegistrationTargetQueryTerms()
      Gets the registration target query terms.
      Returns:
      the registration target query terms
      Compliance:
      mandatory - This method must be implemented.

    • getStudentIdTerms

      IdTerm[] getStudentIdTerms()
      Gets the student Id query terms.
      Returns:
      the student 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.

    • getCreditsTerms

      DecimalTerm[] getCreditsTerms()
      Gets the credits query terms.
      Returns:
      the credits query terms
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionIdTerms

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

    • getGradingOptionTerms

      GradeSystemQueryInspector[] getGradingOptionTerms()
      Gets the grade system query terms.
      Returns:
      the grade system 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.

    • getRegistrationQueryInspectorRecord

      RegistrationQueryInspectorRecord getRegistrationQueryInspectorRecord(Type registrationRecordType) throws OperationFailedException
      Gets the registration query inspector record corresponding to the given Registration record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      registrationRecordType - a registration record type
      Returns:
      the registration query inspector record
      Throws:
      NullArgumentException - registrationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(registrationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.