Interface | osid.OsidTemporalQuery | ||
---|---|---|---|
Implements | osid.OsidQuery | ||
Description |
This is the query interface for searching temporal objects.
Each method specifies an | ||
Method | matchEffective | ||
Description |
Match effective objects where the current date falls within the start and end dates inclusive. | ||
Parameters | boolean | match | true to match any effective, false to match
ineffective |
Compliance | mandatory | This method must be implemented. | |
Method | clearEffectiveTerms | ||
Description |
Clears the effective query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchStartDate | ||
Description |
Matches temporals 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 temporals 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 temporals 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 temporals 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 | matchDate | ||
Description |
Matches temporals where the given date range falls entirely between the start and end dates inclusive. | ||
Parameters | osid.calendaring.DateTime | from | start date |
osid.calendaring.DateTime | to | end date | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is less than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDateTerms | ||
Description |
Clears the date query terms. | ||
Compliance | mandatory | This method must be implemented. |