Interface | osid.offering.OfferingQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching offerings. Each method
specifies an | ||
Method | matchCanonicalUnitId | ||
Description |
Sets the canonical unit | ||
Parameters | osid.id.Id | canonicalUnitId | a canonica unitl Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | canonicalUnitId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCanonicalUnitIdTerms | ||
Description |
Clears the canonical unit | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCanonicalUnitQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a canonical unit query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitQuery | ||
Description |
Gets the query for a canonical unit. Multiple
retrievals produce a nested | ||
Return | osid.offering.CanonicalUnitQuery | the canonical unit query | |
Errors | UNIMPLEMENTED | supportsCanonicalUnitQuery() is false | |
Compliance | optional | This method must be implemented if supportsCanonicalUnitQuery()
is true. | |
Method | clearCanonicalUnitTerms | ||
Description |
Clears the canonical unit terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTimePeriodId | ||
Description |
Sets the time period | ||
Parameters | osid.id.Id | timePeriodId | a time period Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | timePeriodId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearTimePeriodIdTerms | ||
Description |
Clears the time period | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsTimePeriodQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a time period query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodQuery | ||
Description |
Gets the query for a time period. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.TimePeriodQuery | the time period query | |
Errors | UNIMPLEMENTED | supportsTimePeriodQuery() is false | |
Compliance | optional | This method must be implemented if supportsTimePeriodQuery()
is true. | |
Method | clearTimePeriodTerms | ||
Description |
Clears the time period terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTitle | ||
Description |
Matches a title. | ||
Parameters | string | title | a title |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | title is not of stringMatchType | |
NULL_ARGUMENT | title or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTitle | ||
Description |
Matches offerings with any title. | ||
Parameters | boolean | match | true to match offerings with any title, false
to match offerings with no title |
Compliance | mandatory | This method must be implemented. | |
Method | clearTitleTerms | ||
Description |
Clears all title terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCode | ||
Description |
Matches a code. | ||
Parameters | string | code | a code |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | code is not of stringMatchType | |
NULL_ARGUMENT | code or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCode | ||
Description |
Matches offerings with any code. | ||
Parameters | boolean | match | true to match offerings with any code, false
to match offerings with no code |
Compliance | mandatory | This method must be implemented. | |
Method | clearCodeTerms | ||
Description |
Clears all code terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResultOptionId | ||
Description |
Sets the grade system | ||
Parameters | osid.id.Id | gradeSystemId | a grade system Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResultOptionIdTerms | ||
Description |
Clears the grade system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResultOptionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResultOptionQuery | ||
Description |
Gets the query for a grading option. Multiple
retrievals produce a nested | ||
Return | osid.grading.GradeSystemQuery | a grade system query | |
Errors | UNIMPLEMENTED | supportsResultOptionQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradingOptionQuery()
is true. | |
Method | matchAnyResultOption | ||
Description |
Matches offerings that have any grading option. | ||
Parameters | boolean | match | true to match offerings with any grading option,
false to match offerings with no grading options |
Compliance | mandatory | This method must be implemented. | |
Method | clearResultOptionTerms | ||
Description |
Clears the grading option terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSponsorId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSponsorIdTerms | ||
Description |
Clears the sponsor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSponsorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsorQuery | ||
Description |
Gets the query for a sponsor. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | a resource query | |
Errors | UNIMPLEMENTED | supportsSponsorQuery() is false | |
Compliance | optional | This method must be implemented if supportsSponsorQuery() is
true. | |
Method | matchAnySponsor | ||
Description |
Matches offerings that have any sponsor. | ||
Parameters | boolean | match | true to match offerings with any sponsor, false
to match offerings with no sponsors |
Compliance | mandatory | This method must be implemented. | |
Method | clearSponsorTerms | ||
Description |
Clears the sponsor terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCatalogueId | ||
Description |
Sets the catalogue | ||
Parameters | osid.id.Id | catalogueId | a 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 all 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 query. 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 all catalogue terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingQueryRecord | ||
Description |
Gets the offering query record corresponding to the
given | ||
Parameters | osid.type.Type | offeringRecordType | an offering record type |
Return | osid.offering.records.OfferingQueryRecord | the offering query record | |
Errors | NULL_ARGUMENT | offeringRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(offeringRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |