Interface OfferingConstrainerQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidConstrainerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable
public interface OfferingConstrainerQuery extends OsidConstrainerQuery

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

  • Method Details

    • matchRuledCanonicalUnitId

      void matchRuledCanonicalUnitId(Id canonicalUnitId, boolean match)
      Matches mapped to the canonical unit.
      Parameters:
      canonicalUnitId - the canonical unit Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - canonicalUnitId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledCanonicalUnitIdTerms

      void clearRuledCanonicalUnitIdTerms()
      Clears the canonical unit Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuledCanonicalUnitQuery

      boolean supportsRuledCanonicalUnitQuery()
      Tests if an CanonicalUnitQuery is available.
      Returns:
      true if a canonical unit query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRuledCanonicalUnitQuery

      CanonicalUnitQuery getRuledCanonicalUnitQuery()
      Gets the query for a canonical unit. Multiple retrievals produce a nested OR term.
      Returns:
      the canonical unit query
      Throws:
      UnimplementedException - supportsRuledCanonicalUnitQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRuledCanonicalUnitQuery()} is {@code true} .

    • matchAnyRuledCanonicalUnit

      void matchAnyRuledCanonicalUnit(boolean match)
      Matches rules mapped to any canonical unit.
      Parameters:
      match - true for mapped to any canonical unit, false to match mapped to no canonicalUnit
      Compliance:
      mandatory - This method must be implemented.

    • clearRuledCanonicalUnitTerms

      void clearRuledCanonicalUnitTerms()
      Clears the canonical unit query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchOverrideDescription

      void matchOverrideDescription(boolean match)
      Matches description overrides.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyOverrideDescription

      void matchAnyOverrideDescription(boolean match)
      Matches any description override.
      Parameters:
      match - true for any description override, false to match no description override
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideDescriptionTerms

      void clearOverrideDescriptionTerms()
      Clears the description override query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchOverrideTitle

      void matchOverrideTitle(boolean match)
      Matches title overrides.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyOverrideTitle

      void matchAnyOverrideTitle(boolean match)
      Matches any title override.
      Parameters:
      match - true for any title override, false to match no title override
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideTitleTerms

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

    • matchOverrideCode

      void matchOverrideCode(boolean match)
      Matches code overrides.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyOverrideCode

      void matchAnyOverrideCode(boolean match)
      Matches any code override.
      Parameters:
      match - true for any code override, false to match no code override
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideCodeTerms

      void clearOverrideCodeTerms()
      Clears the code override query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchOverrideTimePeriods

      void matchOverrideTimePeriods(boolean match)
      Matches time periods overrides.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyOverrideTimePeriods

      void matchAnyOverrideTimePeriods(boolean match)
      Matches any time periods override.
      Parameters:
      match - true for any time periods override, false to match no time periods override
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideTimePeriodsTerms

      void clearOverrideTimePeriodsTerms()
      Clears the time periods override query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchConstrainTimePeriods

      void matchConstrainTimePeriods(boolean match)
      Matches constrain time periods.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyConstrainTimePeriods

      void matchAnyConstrainTimePeriods(boolean match)
      Matches any constrain time periods.
      Parameters:
      match - true for any time periods constraints, false to match no time periods constraints
      Compliance:
      mandatory - This method must be implemented.

    • clearConstrainTimePeriodsTerms

      void clearConstrainTimePeriodsTerms()
      Clears the constrain time periods query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchOverrideResultOptions

      void matchOverrideResultOptions(boolean match)
      Matches result options overrides.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyOverrideResultOptions

      void matchAnyOverrideResultOptions(boolean match)
      Matches any result options override.
      Parameters:
      match - true for any result options override, false to match no result options override
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideResultOptionsTerms

      void clearOverrideResultOptionsTerms()
      Clears the result options override query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchConstrainResultOptions

      void matchConstrainResultOptions(boolean match)
      Matches constrain result options.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyConstrainResultOptions

      void matchAnyConstrainResultOptions(boolean match)
      Matches any constrain result options.
      Parameters:
      match - true for any result options constraints, false to match no result options constraints
      Compliance:
      mandatory - This method must be implemented.

    • clearConstrainResultOptionsTerms

      void clearConstrainResultOptionsTerms()
      Clears the constrain result options query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchOverrideSponsors

      void matchOverrideSponsors(boolean match)
      Matches result options overrides.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyOverrideSponsors

      void matchAnyOverrideSponsors(boolean match)
      Matches any sponsors override.
      Parameters:
      match - true for any sponsors override, false to match no sponsors override
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideSponsorsTerms

      void clearOverrideSponsorsTerms()
      Clears the sponsors override query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchConstrainSponsors

      void matchConstrainSponsors(boolean match)
      Matches constrain sponsors.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyConstrainSponsors

      void matchAnyConstrainSponsors(boolean match)
      Matches any constrain sponsors.
      Parameters:
      match - true for any sponsors constraints, false to match no sponsors constraints
      Compliance:
      mandatory - This method must be implemented.

    • clearConstrainSponsorsTerms

      void clearConstrainSponsorsTerms()
      Clears the constrain sponsors query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCatalogueId

      void matchCatalogueId(Id catalogueId, boolean match)
      Matches mapped to the catalogue.
      Parameters:
      catalogueId - the catalogue Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - catalogueId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCatalogueIdTerms

      void clearCatalogueIdTerms()
      Clears the catalogue Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCatalogueQuery

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

    • getCatalogueQuery

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

    • clearCatalogueTerms

      void clearCatalogueTerms()
      Clears the catalogue query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerQueryRecord

      OfferingConstrainerQueryRecord getOfferingConstrainerQueryRecord(Type offeringConstrainerRecordType) throws OperationFailedException
      Gets the offering constrainer query record corresponding to the given OfferingConstrainer record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      offeringConstrainerRecordType - an offering constrainer record type
      Returns:
      the offering constrainer query record
      Throws:
      NullArgumentException - offeringConstrainerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(offeringConstrainerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.