Interface ProgramEntryQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface ProgramEntryQuery extends OsidRelationshipQuery

This is the query for searching program entries. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchStudentId

      void matchStudentId(Id resourceId, boolean match)
      Sets the student Id for this query.
      Parameters:
      resourceId - a resource Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStudentIdTerms

      void clearStudentIdTerms()
      Clears the student Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentQuery

      boolean supportsStudentQuery()
      Tests if a StudentQuery is available.
      Returns:
      true if a student query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStudentQuery

      ResourceQuery getStudentQuery()
      Gets the query for a student option. Multiple retrievals produce a nested OR term.
      Returns:
      a student query
      Throws:
      UnimplementedException - supportsStudentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentQuery()} is {@code true} .

    • clearStudentTerms

      void clearStudentTerms()
      Clears the student option terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchProgramId

      void matchProgramId(Id programId, boolean match)
      Sets the program Id for this query to match entries that have an entry for the given course.
      Parameters:
      programId - a program Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - programId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProgramIdTerms

      void clearProgramIdTerms()
      Clears the program Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProgramQuery

      boolean supportsProgramQuery()
      Tests if a ProgramQuery is available.
      Returns:
      true if a program query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProgramQuery

      ProgramQuery getProgramQuery()
      Gets the query for a program entry. Multiple retrievals produce a nested OR term.
      Returns:
      a program query
      Throws:
      UnimplementedException - supportsProgramQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramQuery()} is {@code true} .

    • clearProgramTerms

      void clearProgramTerms()
      Clears the program terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchParentProgramEntryId

      void matchParentProgramEntryId(Id programEntryId, boolean match)
      Sets the parent program entry Id for this query.
      Parameters:
      programEntryId - a program entry Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - programEntryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearParentProgramEntryIdTerms

      void clearParentProgramEntryIdTerms()
      Clears the parent program entry Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsParentProgramEntryQuery

      boolean supportsParentProgramEntryQuery()
      Tests if a ProgramEntryQuery is available.
      Returns:
      true if a program entry query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getParentProgramEntryQuery

      ProgramEntryQuery getParentProgramEntryQuery()
      Gets the query for a parent program entry. Multiple retrievals produce a nested OR term.
      Returns:
      a parent program entry query
      Throws:
      UnimplementedException - supportsParentProgramEntryQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParentProgramEntryQuery()} is {@code true} .

    • matchAnyParentProgramEntry

      void matchAnyParentProgramEntry(boolean match)
      Matches program entries that have any parent.
      Parameters:
      match - true to match entries with a parent, false to match entries with no parent
      Compliance:
      mandatory - This method must be implemented.

    • clearParentProgramEntryTerms

      void clearParentProgramEntryTerms()
      Clears the parent program entry terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsMatriculationKnown

      void matchIsMatriculationKnown(boolean match)
      Matches credential entries with a matriculation known value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsMatriculationKnownTerms

      void clearIsMatriculationKnownTerms()
      Clears the matriculation known terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEntranceDate

      void matchEntranceDate(DateTime from, DateTime to, boolean match)
      Matches entrance dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyEntranceDate

      void matchAnyEntranceDate(boolean match)
      Matches program entries with any entrance date.
      Parameters:
      match - true to match entries with a entrance date, false to match entries with no entrance date
      Compliance:
      mandatory - This method must be implemented.

    • clearEntranceDateTerms

      void clearEntranceDateTerms()
      Clears the entrance date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEntranceTermId

      void matchEntranceTermId(Id entranceTermId, boolean match)
      Sets the entrance term Id for this query.
      Parameters:
      entranceTermId - a entrance term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - entranceTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEntranceTermIdTerms

      void clearEntranceTermIdTerms()
      Clears the entrance term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntranceTermQuery

      boolean supportsEntranceTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a entrance term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEntranceTermQuery

      TermQuery getEntranceTermQuery()
      Gets the query for a entrance term. Multiple retrievals produce a nested OR term.
      Returns:
      a entrance term query
      Throws:
      UnimplementedException - supportsEntranceTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEntranceTermQuery()} is {@code true} .

    • clearEntranceTermTerms

      void clearEntranceTermTerms()
      Clears the entrance term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsExpectedToComplete

      void matchIsExpectedToComplete(boolean match)
      Matches credential entries with a expected to complete value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsExpectedToCompleteTerms

      void clearIsExpectedToCompleteTerms()
      Clears the expected to complete terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchExpectedCompletionDate

      void matchExpectedCompletionDate(DateTime from, DateTime to, boolean match)
      Matches expected completion dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyExpectedCompletionDate

      void matchAnyExpectedCompletionDate(boolean match)
      Matches program entries with any expected completion date.
      Parameters:
      match - true to match entries with a expected completion date, false to match entries with no expected completion date
      Compliance:
      mandatory - This method must be implemented.

    • clearExpectedCompletionDateTerms

      void clearExpectedCompletionDateTerms()
      Clears the expected completion date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchExpectedCompletionTermId

      void matchExpectedCompletionTermId(Id expectedCompletionTermId, boolean match)
      Sets the expected completion term Id for this query.
      Parameters:
      expectedCompletionTermId - a expected completion term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - expectedCompletionTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearExpectedCompletionTermIdTerms

      void clearExpectedCompletionTermIdTerms()
      Clears the expected completion term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsExpectedCompletionTermQuery

      boolean supportsExpectedCompletionTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a expected completion term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermQuery

      TermQuery getExpectedCompletionTermQuery()
      Gets the query for a expected completion term. Multiple retrievals produce a nested OR term.
      Returns:
      a expected completion term query
      Throws:
      UnimplementedException - supportsExpectedCompletionTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsExpectedCompletionTermQuery()} is {@code true} .

    • clearExpectedCompletionTermTerms

      void clearExpectedCompletionTermTerms()
      Clears the expected completion term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsEnrolled

      void matchIsEnrolled(boolean match)
      Matches credential entries with a enrolled value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsEnrolledTerms

      void clearIsEnrolledTerms()
      Clears the enrolled terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsActivelyEnrolled

      void matchIsActivelyEnrolled(boolean match)
      Matches credential entries with a actively enrolled value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsActivelyEnrolledTerms

      void clearIsActivelyEnrolledTerms()
      Clears the actively enrolled terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsOnLeave

      void matchIsOnLeave(boolean match)
      Matches credential entries with a on leave value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsOnLeaveTerms

      void clearIsOnLeaveTerms()
      Clears the on leave terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHasWithdrawn

      void matchHasWithdrawn(boolean match)
      Matches credential entries with a withdrawn value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearHasWithdrawnTerms

      void clearHasWithdrawnTerms()
      Clears the withdrawn terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchWithdrawDate

      void matchWithdrawDate(DateTime from, DateTime to, boolean match)
      Matches withdraw dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyWithdrawDate

      void matchAnyWithdrawDate(boolean match)
      Matches program entries with any withdraw date.
      Parameters:
      match - true to match entries with a withdraw date, false to match entries with no withdraw date
      Compliance:
      mandatory - This method must be implemented.

    • clearWithdrawDateTerms

      void clearWithdrawDateTerms()
      Clears the withdraw date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchWithdrawTermId

      void matchWithdrawTermId(Id withdrawTermId, boolean match)
      Sets the withdraw term Id for this query.
      Parameters:
      withdrawTermId - a withdraw term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - withdrawTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWithdrawTermIdTerms

      void clearWithdrawTermIdTerms()
      Clears the withdraw term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsWithdrawTermQuery

      boolean supportsWithdrawTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a withdraw term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getWithdrawTermQuery

      TermQuery getWithdrawTermQuery()
      Gets the query for a withdraw term. Multiple retrievals produce a nested OR term.
      Returns:
      a withdraw term query
      Throws:
      UnimplementedException - supportsWithdrawTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsWithdrawTermQuery()} is {@code true} .

    • clearWithdrawTermTerms

      void clearWithdrawTermTerms()
      Clears the withdraw term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchComplete

      void matchComplete(boolean match)
      Matches completed programs.
      Parameters:
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearCompleteTerms

      void clearCompleteTerms()
      Clears the complete terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCompletionDate

      void matchCompletionDate(DateTime from, DateTime to, boolean match)
      Matches completion dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCompletionDate

      void matchAnyCompletionDate(boolean match)
      Matches program entries with any completion date.
      Parameters:
      match - true to match entries with a completion date, false to match entries with no completion date
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionDateTerms

      void clearCompletionDateTerms()
      Clears the completion date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCompletionTermId

      void matchCompletionTermId(Id completionTermId, boolean match)
      Sets the completion term Id for this query.
      Parameters:
      completionTermId - a completion term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - completionTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionTermIdTerms

      void clearCompletionTermIdTerms()
      Clears the completion term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCompletionTermQuery

      boolean supportsCompletionTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a completion term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionTermQuery

      TermQuery getCompletionTermQuery()
      Gets the query for a completion term. Multiple retrievals produce a nested OR term.
      Returns:
      a completion term query
      Throws:
      UnimplementedException - supportsCompletionTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCompletionTermQuery()} is {@code true} .

    • clearCompletionTermTerms

      void clearCompletionTermTerms()
      Clears the completion term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLevelId

      void matchLevelId(Id levelId, boolean match)
      Sets the level Id for this query.
      Parameters:
      levelId - a level Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - levelId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLevelIdTerms

      void clearLevelIdTerms()
      Clears the level Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLevelQuery

      boolean supportsLevelQuery()
      Tests if a GradeQuery is available.
      Returns:
      true if a level query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLevelQuery

      GradeQuery getLevelQuery()
      Gets the query for a level. Multiple retrievals produce a nested OR term.
      Returns:
      a level query
      Throws:
      UnimplementedException - supportsLevelQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLevelQuery()} is {@code true} .

    • matchAnyLevel

      void matchAnyLevel(boolean match)
      Matches program entries with any level.
      Parameters:
      match - true to match entries with a level, false to match entries with no level
      Compliance:
      mandatory - This method must be implemented.

    • clearLevelTerms

      void clearLevelTerms()
      Clears the level terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchStandingId

      void matchStandingId(Id standingId, boolean match)
      Sets the standing Id for this query.
      Parameters:
      standingId - a standing Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - standingId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStandingIdTerms

      void clearStandingIdTerms()
      Clears the standing Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStandingQuery

      boolean supportsStandingQuery()
      Tests if a GradeQuery is available.
      Returns:
      true if a standing query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStandingQuery

      GradeQuery getStandingQuery()
      Gets the query for a standing. Multiple retrievals produce a nested OR term.
      Returns:
      a standing query
      Throws:
      UnimplementedException - supportsStandingQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStandingQuery()} is {@code true} .

    • matchAnyStanding

      void matchAnyStanding(boolean match)
      Matches program entries with any standing.
      Parameters:
      match - true to match entries with a standing, false to match entries with no standing
      Compliance:
      mandatory - This method must be implemented.

    • clearStandingTerms

      void clearStandingTerms()
      Clears the standing terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAdmissionDate

      void matchAdmissionDate(DateTime from, DateTime to, boolean match)
      Matches admission dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyAdmissionDate

      void matchAnyAdmissionDate(boolean match)
      Matches entries that have any admission date.
      Parameters:
      match - true to match entries with any admission date, false to match entries with no admission date
      Compliance:
      mandatory - This method must be implemented.

    • clearAdmissionDateTerms

      void clearAdmissionDateTerms()
      Clears the admission date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTermId

      void matchTermId(Id termId, boolean match)
      Sets the term Id for this query.
      Parameters:
      termId - a term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - termId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTermIdTerms

      void clearTermIdTerms()
      Clears the term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermQuery

      boolean supportsTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTermQuery

      TermQuery getTermQuery()
      Gets the query for a term entry. Multiple retrievals produce a nested OR term.
      Returns:
      a term query
      Throws:
      UnimplementedException - supportsTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTermQuery()} is {@code true} .

    • matchAnyTerm

      void matchAnyTerm(boolean match)
      Matches entries that have any term.
      Parameters:
      match - true to match entries specific to a term, false to match entries for the entire enrollment
      Compliance:
      mandatory - This method must be implemented.

    • clearTermTerms

      void clearTermTerms()
      Clears the term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditScaleId

      void matchCreditScaleId(Id gradeSystemId, boolean match)
      Matches a credit scale Id .
      Parameters:
      gradeSystemId - a grade system Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditScaleIdTerms

      void clearCreditScaleIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreditScaleQuery

      boolean supportsCreditScaleQuery()
      Tests if a GradeSystemQuery is available.
      Returns:
      true if a grade system query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreditScaleQuery

      GradeSystemQuery getCreditScaleQuery()
      Gets the query for a grade system. Multiple retrievals produce a nested OR term.
      Returns:
      a grade system query
      Throws:
      UnimplementedException - supportsCreditScaleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreditScaleQuery()} is {@code true} .

    • matchAnyCreditScale

      void matchAnyCreditScale(boolean match)
      Matches entries that have any credit scale.
      Parameters:
      match - true to match entries with any credit scale, false to match entries with no credit scale
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditScaleTerms

      void clearCreditScaleTerms()
      Clears the credit scale terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditsEarned

      void matchCreditsEarned(BigDecimal from, BigDecimal to, boolean match)
      Matches earned credits between the given range inclusive.
      Parameters:
      from - starting value
      to - ending value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCreditsEarned

      void matchAnyCreditsEarned(boolean match)
      Matches entries that have any earned credits.
      Parameters:
      match - true to match entries with any earned credits, false to match entries with no earned credits
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditsEarnedTerms

      void clearCreditsEarnedTerms()
      Clears the earned credits terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGPAScaleId

      void matchGPAScaleId(Id gradeSystemId, boolean match)
      Matches a GPA scale Id .
      Parameters:
      gradeSystemId - a grade system Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGPAScaleIdTerms

      void clearGPAScaleIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsGPAScaleQuery

      boolean supportsGPAScaleQuery()
      Tests if a GradeSystemQuery is available.
      Returns:
      true if a grade system query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGPAScaleQuery

      GradeSystemQuery getGPAScaleQuery()
      Gets the query for a grade system. Multiple retrievals produce a nested OR term.
      Returns:
      a grade system query
      Throws:
      UnimplementedException - supportsGPAScaleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGPAScaleQuery()} is {@code true} .

    • matchAnyGPAScale

      void matchAnyGPAScale(boolean match)
      Matches entries that have any GPA scale.
      Parameters:
      match - true to match entries with any GPA scale, false to match entries with no GPA scale
      Compliance:
      mandatory - This method must be implemented.

    • clearGPAScaleTerms

      void clearGPAScaleTerms()
      Clears the credit scale terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGPA

      void matchGPA(BigDecimal from, BigDecimal to, boolean match)
      Matches GPA between the given range inclusive.
      Parameters:
      from - starting value
      to - ending value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyGPA

      void matchAnyGPA(boolean match)
      Matches entries that have any GPA.
      Parameters:
      match - true to match entries with any GPA, false to match entries with no GPA
      Compliance:
      mandatory - This method must be implemented.

    • clearGPATerms

      void clearGPATerms()
      Clears the GPA terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchEnrollmentId

      void matchEnrollmentId(Id enrollmentId, boolean match)
      Sets the enrollment Id for this query.
      Parameters:
      enrollmentId - an enrollment Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - enrollmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEnrollmentIdTerms

      void clearEnrollmentIdTerms()
      Clears the enrollment Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsEnrollmentQuery

      boolean supportsEnrollmentQuery()
      Tests if an EnrollmentQuery is available.
      Returns:
      true if an enrollment query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEnrollmentQuery

      EnrollmentQuery getEnrollmentQuery()
      Gets the query for an enrollment entry. Multiple retrievals produce a nested OR term.
      Returns:
      an enrollment query
      Throws:
      UnimplementedException - supportsEnrollmentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentQuery()} is {@code true} .

    • matchAnyEnrollment

      void matchAnyEnrollment(boolean match)
      Matches entries that have any enrollment.
      Parameters:
      match - true to match enries with any enrollment, false to match enries with no enrollments
      Compliance:
      mandatory - This method must be implemented.

    • clearEnrollmentTerms

      void clearEnrollmentTerms()
      Clears the enrollment terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseCatalogId

      void matchCourseCatalogId(Id courseCatalogId, boolean match)
      Sets the course catalog Id for this query to match entries assigned to course catalogs.
      Parameters:
      courseCatalogId - the course catalog Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - courseCatalogId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseCatalogIdTerms

      void clearCourseCatalogIdTerms()
      Clears the course catalog Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogQuery

      boolean supportsCourseCatalogQuery()
      Tests if a CourseCatalogQuery is available.
      Returns:
      true if a course catalog query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogQuery

      CourseCatalogQuery getCourseCatalogQuery()
      Gets the query for a course catalog. Multiple retrievals produce a nested OR term.
      Returns:
      the course catalog query
      Throws:
      UnimplementedException - supportsCourseCatalogQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .

    • clearCourseCatalogTerms

      void clearCourseCatalogTerms()
      Clears the course catalog terms.
      Compliance:
      mandatory - This method must be implemented.

    • getProgramEntryQueryRecord

      ProgramEntryQueryRecord getProgramEntryQueryRecord(Type programEntryRecordType) throws OperationFailedException
      Gets the program entry query 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 record
      Throws:
      NullArgumentException - programEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(programEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.