Interface RequisiteQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidContainableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable
public interface RequisiteQuery extends OsidRuleQuery, OsidEnablerQuery, OsidContainableQuery

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

  • Method Details

    • matchRequisiteOptionId

      void matchRequisiteOptionId(Id requisiteId, boolean match)
      Sets the requisite Id for this query to match requisites that a requisite option.
      Parameters:
      requisiteId - a requisite Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - requisiteId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRequisiteOptionIdTerms

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

    • supportsRequisiteOptionQuery

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

    • getRequisiteOptionQuery

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

    • matchAnyRequisiteOption

      void matchAnyRequisiteOption(boolean match)
      Matches requisites that have any requisite option.
      Parameters:
      match - true to match requisites with any requisite option, false to match requisites with no requisite options
      Compliance:
      mandatory - This method must be implemented.

    • clearRequisiteOptionTerms

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

    • matchCourseId

      void matchCourseId(Id courseId, boolean match)
      Sets the course Id for this query to match requisites that have a requirement for the given course.
      Parameters:
      courseId - a course Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - courseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseIdTerms

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

    • supportsCourseQuery

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

    • getCourseQuery

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

    • matchAnyCourse

      void matchAnyCourse(boolean match)
      Matches requisites that have any course requirement.
      Parameters:
      match - true to match requisites with any course requirement, false to match requisites with no course requirements
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseTerms

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

    • matchProgramId

      void matchProgramId(Id programId, boolean match)
      Sets the program Id for this query to match requisites that have a requirement for the given program.
      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 requirement. 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} .

    • matchAnyProgram

      void matchAnyProgram(boolean match)
      Matches requisites that have any program requirement.
      Parameters:
      match - true to match requisites with any program requirement, false to match requisites with no program requirements
      Compliance:
      mandatory - This method must be implemented.

    • clearProgramTerms

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

    • matchCredentialId

      void matchCredentialId(Id credentialId, boolean match)
      Sets the credential Id for this query to match requisites that have a requirement for the given credential.
      Parameters:
      credentialId - a credential Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - credentialId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCredentialIdTerms

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

    • supportsCredentialQuery

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

    • getCredentialQuery

      CredentialQuery getCredentialQuery()
      Gets the query for a credential requirement. Multiple retrievals produce a nested OR term.
      Returns:
      a credential query
      Throws:
      UnimplementedException - supportsCredentialQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialQuery()} is {@code true} .

    • matchAnyCredential

      void matchAnyCredential(boolean match)
      Matches requisites that have any credential requirement.
      Parameters:
      match - true to match requisites with any credential requirement, false to match requisites with no credential requirements
      Compliance:
      mandatory - This method must be implemented.

    • clearCredentialTerms

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

    • matchLearningObjectiveId

      void matchLearningObjectiveId(Id objectiveId, boolean match)
      Sets the learning objective Id for this query to match requisites that have a requirement for the given learning objective.
      Parameters:
      objectiveId - a learning objective Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - objectiveId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectiveIdTerms

      void clearLearningObjectiveIdTerms()
      Clears the learning objective Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLearningObjectiveQuery

      boolean supportsLearningObjectiveQuery()
      Tests if a LearningObjectiveQuery is available.
      Returns:
      true if a learning objective query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveQuery

      ObjectiveQuery getLearningObjectiveQuery()
      Gets the query for a learning objective requirement. Multiple retrievals produce a nested OR term.
      Returns:
      a learning objective query
      Throws:
      UnimplementedException - supportsLearningObjectiveQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLearningObjectiveQuery()} is {@code true} .

    • matchAnyLearningObjective

      void matchAnyLearningObjective(boolean match)
      Matches requisites that have any learning objective requirement.
      Parameters:
      match - true to match requisites with any learning objective requirement, false to match requisites with no learning objective requirements
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectiveTerms

      void clearLearningObjectiveTerms()
      Clears the learning objective terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAssessmentId

      void matchAssessmentId(Id assessmentId, boolean match)
      Sets the assessment Id for this query to match requisites that have a requirement for the given assessment.
      Parameters:
      assessmentId - an assessment Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentIdTerms

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

    • supportsAssessmentQuery

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

    • getAssessmentQuery

      AssessmentQuery getAssessmentQuery()
      Gets the query for an assessment requirement. Multiple retrievals produce a nested OR term.
      Returns:
      an assessment query
      Throws:
      UnimplementedException - supportsAssessmentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentQuery()} is {@code true} .

    • matchAnyAssessment

      void matchAnyAssessment(boolean match)
      Matches requisites that have any assessment requirement.
      Parameters:
      match - true to match requisites with any assessment requirement, false to match requisites with no assessment requirements
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentTerms

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

    • matchAwardId

      void matchAwardId(Id awardId, boolean match)
      Sets the award Id for this query to match requisites that have a requirement for the given award.
      Parameters:
      awardId - an award Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - awardId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAwardIdTerms

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

    • supportsAwardQuery

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

    • getAwardQuery

      AwardQuery getAwardQuery()
      Gets the query for an award requirement. Multiple retrievals produce a nested OR term.
      Returns:
      an award query
      Throws:
      UnimplementedException - supportsAwardQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardQuery()} is {@code true} .

    • matchAnyAward

      void matchAnyAward(boolean match)
      Matches requisites that have any award requirement.
      Parameters:
      match - true to match requisites with any award requirement, false to match requisites with no award requirements
      Compliance:
      mandatory - This method must be implemented.

    • clearAwardTerms

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

    • matchContainingRequisiteId

      void matchContainingRequisiteId(Id requisiteId, boolean match)
      Sets the requisite Id for this query to match requisites that have the specified requisite as an ancestor.
      Parameters:
      requisiteId - a requisite Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - requisiteId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearContainingRequisiteIdTerms

      void clearContainingRequisiteIdTerms()
      Clears the containing requisite Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsContainingRequisiteQuery

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

    • getContainingRequisiteQuery

      RequisiteQuery getContainingRequisiteQuery()
      Gets the query for a containing requisite.
      Returns:
      the containing requisite query
      Throws:
      UnimplementedException - supportsContainingRequisiteQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsContainingRequisiteQuery()} is {@code true} .

    • matchAnyContainingRequisite

      void matchAnyContainingRequisite(boolean match)
      Matches requisites with any ancestor requisite.
      Parameters:
      match - true to match requisites with any ancestor requisite, false to match requisites with no ancestor requisites
      Compliance:
      mandatory - This method must be implemented.

    • clearContainingRequisiteTerms

      void clearContainingRequisiteTerms()
      Clears the containing requisite 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 requisites 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.

    • getRequisiteQueryRecord

      RequisiteQueryRecord getRequisiteQueryRecord(Type requisiteRecordType) throws OperationFailedException
      Gets the requisite query record corresponding to the given Requisite record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      requisiteRecordType - a requisites record type
      Returns:
      the requisite query record
      Throws:
      NullArgumentException - requisiteRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(requisiteRecordType) is false
      Compliance:
      mandatory - This method must be implemented.