Interface | osid.OsidCompendiumQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query interface for searching reports. Each
method specifies an | ||
Method | matchStartDate | ||
Description |
Matches reports whose start date falls in between the given dates inclusive. | ||
Parameters | osid.calendaring.DateTime | start | start of date range |
osid.calendaring.DateTime | end | end of date range | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is less than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyStartDate | ||
Description |
Matches reports with any start date set. | ||
Parameters | boolean | match | true to match any start date, false to match
no start date |
Compliance | mandatory | This method must be implemented. | |
Method | clearStartDateTerms | ||
Description |
Clears the start date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchEndDate | ||
Description |
Matches reports whose effective end date falls in between the given dates inclusive. | ||
Parameters | osid.calendaring.DateTime | start | start of date range |
osid.calendaring.DateTime | end | end of date range | |
boolean | match | true if a positive match, false for negative
match | |
Errors | INVALID_ARGUMENT | start is less than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyEndDate | ||
Description |
Matches reports with any end date set. | ||
Parameters | boolean | match | true to match any end date, false to match no
start date |
Compliance | mandatory | This method must be implemented. | |
Method | clearEndDateTerms | ||
Description |
Clears the end date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInterpolated | ||
Description |
Match reports that are interpolated. | ||
Parameters | boolean | match | true to match any interpolated reports, false
to match non-interpolated reports |
Compliance | mandatory | This method must be implemented. | |
Method | clearInterpolatedTerms | ||
Description |
Clears the interpolated query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchExtrapolated | ||
Description |
Match reports that are extrapolated. | ||
Parameters | boolean | match | true to match any extrapolated reports, false
to match non-extrapolated reports |
Compliance | mandatory | This method must be implemented. | |
Method | clearExtrapolatedTerms | ||
Description |
Clears the extrapolated query terms. | ||
Compliance | mandatory | This method must be implemented. |