Interface ProgramOfferingQuery

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

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

  • Method Details

    • matchProgramId

      void matchProgramId(Id programId, boolean match)
      Sets the program Id for this query to match program offerings that have a related 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. Multiple retrievals produce a nested OR term.
      Returns:
      the 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.

    • matchTermId

      void matchTermId(Id termId, boolean match)
      Sets the term Id for this query to match program offerings that have a related term.
      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 reporting term. Multiple retrievals produce a nested OR term.
      Returns:
      the term query
      Throws:
      UnimplementedException - supportsTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTermQuery()} is {@code true} .

    • clearTermTerms

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

    • matchTitle

      void matchTitle(String title, Type stringMatchType, boolean match)
      Adds a title for this query.
      Parameters:
      title - title string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - title not of stringMatchType
      NullArgumentException - title or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTitle

      void matchAnyTitle(boolean match)
      Matches a title that has any value.
      Parameters:
      match - true to match program offerings with any title, false to match program offerings with no title
      Compliance:
      mandatory - This method must be implemented.

    • clearTitleTerms

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

    • matchNumber

      void matchNumber(String number, Type stringMatchType, boolean match)
      Adds a program number for this query.
      Parameters:
      number - program number string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - number not of stringMatchType
      NullArgumentException - number or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyNumber

      void matchAnyNumber(boolean match)
      Matches a program number that has any value.
      Parameters:
      match - true to match program offerings with any number, false to match program offerings with no number
      Compliance:
      mandatory - This method must be implemented.

    • clearNumberTerms

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

    • matchSponsorId

      void matchSponsorId(Id resourceId, boolean match)
      Sets the resource Id for this query to match programs that have a sponsor.
      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.

    • clearSponsorIdTerms

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

    • supportsSponsorQuery

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

    • getSponsorQuery

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

    • matchAnySponsor

      void matchAnySponsor(boolean match)
      Matches programs that have any sponsor.
      Parameters:
      match - true to match programs with any sponsor, false to match programs with no sponsors
      Compliance:
      mandatory - This method must be implemented.

    • clearSponsorTerms

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

    • matchParentProgramOfferingId

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

    • clearParentProgramOfferingIdTerms

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

    • supportsParentProgramOfferingQuery

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

    • getParentProgramOfferingQuery

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

    • matchAnyParentProgramOffering

      void matchAnyParentProgramOffering(boolean match)
      Matches program offerings that are part of any parent.
      Parameters:
      match - true to match program offerings that are part of a parent, false to match program offerings with no parent
      Compliance:
      mandatory - This method must be implemented.

    • clearParentProgramOfferingTerms

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

    • matchLearningObjectiveId

      void matchLearningObjectiveId(Id objectiveId, boolean match)
      Sets the objective Id for this query.
      Parameters:
      objectiveId - an 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 objective Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsLearningObjectiveQuery

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

    • getLearningObjectiveQuery

      ObjectiveQuery getLearningObjectiveQuery()
      Gets the query for a learning objective. Multiple retrievals produce a nested OR term.
      Returns:
      an 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 program offerings that have any learning objective.
      Parameters:
      match - true to match program offerings with any learning objective, false to match program offerings with no learning objectives
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectiveTerms

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

    • matchRestrictedAudienceId

      void matchRestrictedAudienceId(Id resourceId, boolean match)
      Sets the resource Id for this query to match program offerings that have a restricted audience.
      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.

    • clearRestrictedAudienceIdTerms

      void clearRestrictedAudienceIdTerms()
      Clears the restricted audience Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRestrictedAudienceQuery

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

    • getRestrictedAudienceQuery

      ResourceQuery getRestrictedAudienceQuery()
      Gets the query for a restricted audience. Multiple retrievals produce a nested OR term.
      Returns:
      a resource query
      Throws:
      UnimplementedException - supportsRestrictedAudienceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRestrictedAudienceQuery()} is {@code true} .

    • matchAnyRestrictedAudience

      void matchAnyRestrictedAudience(boolean match)
      Matches program offerings that have any restricted audience.
      Parameters:
      match - true to match program offerings with any restricted audience, false to match program offerings with no restricted audiences
      Compliance:
      mandatory - This method must be implemented.

    • clearRestrictedAudienceTerms

      void clearRestrictedAudienceTerms()
      Clears the restricted audience terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCompletionRequirementsInfo

      void matchCompletionRequirementsInfo(String requirementsInfo, Type stringMatchType, boolean match)
      Matches programs with the prerequisites informational string.
      Parameters:
      requirementsInfo - completion requirements string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - requirementsInfo not of stringMatchType
      NullArgumentException - requirementsInfo or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCompletionRequirementsInfo

      void matchAnyCompletionRequirementsInfo(boolean match)
      Matches a program that has any completion requirements information assigned.
      Parameters:
      match - true to match programs with any completion requirements information, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionRequirementsInfoTerms

      void clearCompletionRequirementsInfoTerms()
      Clears the completion requirements info terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCompletionRequirementsId

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

    • clearCompletionRequirementsIdTerms

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

    • supportsCompletionRequirementsQuery

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

    • getCompletionRequirementsQuery

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

    • matchAnyCompletionRequirements

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

    • clearCompletionRequirementsTerms

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

    • matchCredentialId

      void matchCredentialId(Id credentialId, boolean match)
      Sets the credential Id for this query.
      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. 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 programs that have any credentials.
      Parameters:
      match - true to match programs with any credentials, false to match programs with no credentials
      Compliance:
      mandatory - This method must be implemented.

    • clearCredentialTerms

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

    • matchRequiresRegistration

      void matchRequiresRegistration(boolean match)
      Matches program offerings that require registration.
      Parameters:
      match - true to match program offerings requiring registration,, false to match program offerings not requiring registration
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresRegistrationTerms

      void clearRequiresRegistrationTerms()
      Clears the requires registration terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMinimumSeats

      void matchMinimumSeats(long min, long max, boolean match)
      Matches program offerings with minimum seating between the given numbers inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumSeats

      void matchAnyMinimumSeats(boolean match)
      Matches a program offering that has any minimum seating assigned.
      Parameters:
      match - true to match program offerings with any minimum seats, false to match program offerings with no minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumSeatsTerms

      void clearMinimumSeatsTerms()
      Clears the minimum seats terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMaximumSeats

      void matchMaximumSeats(long min, long max, boolean match)
      Matches program offerings with maximum seating between the given numbers inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMaximumSeats

      void matchAnyMaximumSeats(boolean match)
      Matches a program offering that has any maximum seating assigned.
      Parameters:
      match - true to match program offerings with any maximum seats, false to match program offerings with no maximum seats
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumSeatsTerms

      void clearMaximumSeatsTerms()
      Clears the maximum seats terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchURL

      void matchURL(String url, Type stringMatchType, boolean match)
      Adds a class url for this query.
      Parameters:
      url - url string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - url not of stringMatchType
      NullArgumentException - url or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyURL

      void matchAnyURL(boolean match)
      Matches a url that has any value.
      Parameters:
      match - true to match program offerings with any url, false to match program offerings with no url
      Compliance:
      mandatory - This method must be implemented.

    • clearURLTerms

      void clearURLTerms()
      Clears the url 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 program offerings 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.

    • getProgramOfferingQueryRecord

      ProgramOfferingQueryRecord getProgramOfferingQueryRecord(Type programOfferingRecordType) throws OperationFailedException
      Gets the program offering query record corresponding to the given ProgramOffering record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      programOfferingRecordType - a program offering record type
      Returns:
      the program offering query record
      Throws:
      NullArgumentException - programOfferingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(programOfferingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.