Interface | osid.offering.rules.CanonicalUnitProcessorEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching canonical unit processor
enablers. Each method match specifies an | ||
Method | matchRuledCanonicalUnitProcessorId | ||
Description |
Matches enablers mapped to the canonical unit processor. | ||
Parameters | osid.id.Id | canonicalUnitProcessorId | the canonical unit Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | canonicalUnitProcessorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledCanonicalUnitProcessorIdTerms | ||
Description |
Clears the canonical unit processor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledCanonicalUnitProcessorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a canonical unit processor query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledCanonicalUnitProcessorQuery | ||
Description |
Gets the query for a canonical unit processor. Multiple
retrievals produce a nested | ||
Return | osid.offering.rules.CanonicalUnitProcessorQuery | the canonical unit processor query | |
Errors | UNIMPLEMENTED | supportsRuledCanonicalUnitProcessorQuery() is false
| |
Compliance | optional | This method must be implemented if
supportsRuledCanonicalUnitProcessorQuery() is true. | |
Method | matchAnyRuledCanonicalUnitProcessor | ||
Description |
Matches enablers mapped to any canonical unit processor. | ||
Parameters | boolean | match | true for enablers mapped to any canonical unit processor,
false to match enablers mapped to no canonical unit processors |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledCanonicalUnitProcessorTerms | ||
Description |
Clears the canonical unit processor query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCatalogueId | ||
Description |
Matches enablers 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 | getCanonicalUnitProcessorEnablerQueryRecord | ||
Description |
Gets the canonical unit processor enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | canonicalUnitProcessorEnablerRecordType | a canonical unit processor enabler record type |
Return | osid.offering.rules.records.CanonicalUnitProcessorEnablerQueryRecord | the canonical unit processor enabler query record | |
Errors | NULL_ARGUMENT | canonicalUnitProcessorEnablerRecordType is null
| |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(canonicalUnitProcessorEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |