OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerQuery
Implementsosid.OsidConstrainerQuery
Description

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.

MethodmatchRuledCanonicalUnitId
Description

Matches mapped to the canonical unit.

Parametersosid.id.IdcanonicalUnitIdthe canonical unit Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT canonicalUnitId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledCanonicalUnitIdTerms
Description

Clears the canonical unit Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledCanonicalUnitQuery
Description

Tests if an CanonicalUnitQuery is available.

Returnboolean true if a canonical unit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledCanonicalUnitQuery
Description

Gets the query for a canonical unit. Multiple retrievals produce a nested OR term.

Returnosid.offering.CanonicalUnitQuerythe canonical unit query
ErrorsUNIMPLEMENTED supportsRuledCanonicalUnitQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledCanonicalUnitQuery() is true.
MethodmatchAnyRuledCanonicalUnit
Description

Matches rules mapped to any canonical unit.

Parametersbooleanmatch true for mapped to any canonical unit, false to match mapped to no canonicalUnit
CompliancemandatoryThis method must be implemented.
MethodclearRuledCanonicalUnitTerms
Description

Clears the canonical unit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverrideDescription
Description

Matches description overrides.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOverrideDescription
Description

Matches any description override.

Parametersbooleanmatch true for any description override, false to match no description override
CompliancemandatoryThis method must be implemented.
MethodclearOverrideDescriptionTerms
Description

Clears the description override query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverrideTitle
Description

Matches title overrides.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOverrideTitle
Description

Matches any title override.

Parametersbooleanmatch true for any title override, false to match no title override
CompliancemandatoryThis method must be implemented.
MethodclearOverrideTitleTerms
Description

Clears the title override query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverrideCode
Description

Matches code overrides.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOverrideCode
Description

Matches any code override.

Parametersbooleanmatch true for any code override, false to match no code override
CompliancemandatoryThis method must be implemented.
MethodclearOverrideCodeTerms
Description

Clears the code override query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverrideTimePeriods
Description

Matches time periods overrides.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOverrideTimePeriods
Description

Matches any time periods override.

Parametersbooleanmatch true for any time periods override, false to match no time periods override
CompliancemandatoryThis method must be implemented.
MethodclearOverrideTimePeriodsTerms
Description

Clears the time periods override query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConstrainTimePeriods
Description

Matches constrain time periods.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyConstrainTimePeriods
Description

Matches any constrain time periods.

Parametersbooleanmatch true for any time periods constraints, false to match no time periods constraints
CompliancemandatoryThis method must be implemented.
MethodclearConstrainTimePeriodsTerms
Description

Clears the constrain time periods query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverrideResultOptions
Description

Matches result options overrides.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOverrideResultOptions
Description

Matches any result options override.

Parametersbooleanmatch true for any result options override, false to match no result options override
CompliancemandatoryThis method must be implemented.
MethodclearOverrideResultOptionsTerms
Description

Clears the result options override query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConstrainResultOptions
Description

Matches constrain result options.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyConstrainResultOptions
Description

Matches any constrain result options.

Parametersbooleanmatch true for any result options constraints, false to match no result options constraints
CompliancemandatoryThis method must be implemented.
MethodclearConstrainResultOptionsTerms
Description

Clears the constrain result options query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverrideSponsors
Description

Matches result options overrides.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOverrideSponsors
Description

Matches any sponsors override.

Parametersbooleanmatch true for any sponsors override, false to match no sponsors override
CompliancemandatoryThis method must be implemented.
MethodclearOverrideSponsorsTerms
Description

Clears the sponsors override query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConstrainSponsors
Description

Matches constrain sponsors.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyConstrainSponsors
Description

Matches any constrain sponsors.

Parametersbooleanmatch true for any sponsors constraints, false to match no sponsors constraints
CompliancemandatoryThis method must be implemented.
MethodclearConstrainSponsorsTerms
Description

Clears the constrain sponsors query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCatalogueId
Description

Matches mapped to the catalogue.

Parametersosid.id.IdcatalogueIdthe catalogue Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT catalogueId is null
CompliancemandatoryThis method must be implemented.
MethodclearCatalogueIdTerms
Description

Clears the catalogue Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCatalogueQuery
Description

Tests if a CatalogueQuery is available.

Returnboolean true if a catalogue query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueQuery
Description

Gets the query for a catalogue. Multiple retrievals produce a nested OR term.

Returnosid.offering.CatalogueQuerythe catalogue query
ErrorsUNIMPLEMENTED supportsCatalogueQuery() is false
ComplianceoptionalThis method must be implemented if supportsCatalogueQuery() is true.
MethodclearCatalogueTerms
Description

Clears the catalogue query terms.

CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerQueryRecord
Description

Gets the offering constrainer query record corresponding to the given OfferingConstrainer record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeofferingConstrainerRecordTypean offering constrainer record type
Returnosid.offering.rules.records.OfferingConstrainerQueryRecordthe offering constrainer query record
ErrorsNULL_ARGUMENT offeringConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.