Interface | osid.offering.ResultQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidTemporalQuery | |||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching results. Each method
specifies an | ||
Method | matchParticipantId | ||
Description |
Sets a participant | ||
Parameters | osid.id.Id | participantId | a participant Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | participantId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearParticipantIdTerms | ||
Description |
Clears all participant | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsParticipantQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a participant query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getParticipantQuery | ||
Description |
Gets the query for a participant query. Multiple
retrievals produce a nested | ||
Return | osid.offering.ParticipantQuery | the participant query | |
Errors | UNIMPLEMENTED | supportsParticipantQuery() is false | |
Compliance | optional | This method must be implemented if supportsParticipantQuery()
is true. | |
Method | clearParticipantTerms | ||
Description |
Clears all participant terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGradeId | ||
Description |
Sets a grade | ||
Parameters | osid.id.Id | gradeId | a grade Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeIdTerms | ||
Description |
Clears all grade | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeQuery | ||
Description |
Gets the query for a grade query. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeQuery | the grade query | |
Errors | UNIMPLEMENTED | supportsGradeQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradeQuery() is
true. | |
Method | matchAnyGrade | ||
Description |
Matches results with any grade. | ||
Parameters | boolean | match | true to match results with any grade, false
to match results with no grade |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeTerms | ||
Description |
Clears all grade terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValue | ||
Description |
Matches a value between the given range inclusive. | ||
Parameters | decimal | from | a starting range |
decimal | to | an ending range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyValue | ||
Description |
Matches results with any value. | ||
Parameters | boolean | match | true to match results with any value, false
to match results with no value |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueTerms | ||
Description |
Clears all value 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 | getResultQueryRecord | ||
Description |
Gets the result query record corresponding to the given
| ||
Parameters | osid.type.Type | resultRecordType | an result record type |
Return | osid.offering.records.ResultQueryRecord | the result query record | |
Errors | NULL_ARGUMENT | resultRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(resultRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |