Interface | osid.offering.rules.CanonicalUnitProcessorQuery | ||
---|---|---|---|
Implements | osid.OsidProcessorQuery | ||
Description |
This is the query for searching canonical unit processors.
Each method match specifies an | ||
Method | matchRuledCanonicalUnitId | ||
Description |
Matches mapped to the canonical unit. | ||
Parameters | osid.id.Id | canonicalUnitId | the canonical unit Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | canonicalUnitId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledCanonicalUnitIdTerms | ||
Description |
Clears the canonical unit | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledCanonicalUnitQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a canonical unit query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledCanonicalUnitQuery | ||
Description |
Gets the query for a canonical unit. Multiple
retrievals produce a nested | ||
Return | osid.offering.CanonicalUnitQuery | the canonical unit query | |
Errors | UNIMPLEMENTED | supportsRuledCanonicalUnitQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledCanonicalUnitQuery()
is true. | |
Method | matchAnyRuledCanonicalUnit | ||
Description |
Matches mapped to any canonical unit. | ||
Parameters | boolean | match | true for mapped to any canonical unit, false
to match mapped to no canonicalUnit |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledCanonicalUnitTerms | ||
Description |
Clears the canonical unit query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCatalogueId | ||
Description |
Matches mapped to the catalogue. | ||
Parameters | osid.id.Id | catalogueId | the catalogue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | catalogueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCatalogueIdTerms | ||
Description |
Clears the catalogue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCatalogueQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a catalogue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueQuery | ||
Description |
Gets the query for a catalogue. Multiple retrievals
produce a nested | ||
Return | osid.offering.CatalogueQuery | the catalogue query | |
Errors | UNIMPLEMENTED | supportsCatalogueQuery() is false | |
Compliance | optional | This method must be implemented if supportsCatalogueQuery()
is true. | |
Method | clearCatalogueTerms | ||
Description |
Clears the catalogue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitProcessorQueryRecord | ||
Description |
Gets the canonical unit processor query record
corresponding to the given | ||
Parameters | osid.type.Type | canonicalUnitProcessorRecordType | a canonical unit processor record type |
Return | osid.offering.rules.records.CanonicalUnitProcessorQueryRecord | the canonical unit processor query record | |
Errors | NULL_ARGUMENT | canonicalUnitProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(canonicalUnitProcessorRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |