OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidTemporalQuery
Implementsosid.OsidQuery
Description

This is the query interface for searching temporal objects. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchEffective
Description

Match effective objects where the current date falls within the start and end dates inclusive.

Parametersbooleanmatch true to match any effective, false to match ineffective
CompliancemandatoryThis method must be implemented.
MethodclearEffectiveTerms
Description

Clears the effective query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStartDate
Description

Matches temporals whose start date falls in between the given dates inclusive.

Parametersosid.calendaring.DateTimestartstart of date range
osid.calendaring.DateTimeendend of date range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is less than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyStartDate
Description

Matches temporals with any start date set.

Parametersbooleanmatch true to match any start date, false to match no start date
CompliancemandatoryThis method must be implemented.
MethodclearStartDateTerms
Description

Clears the start date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEndDate
Description

Matches temporals whose effective end date falls in between the given dates inclusive.

Parametersosid.calendaring.DateTimestartstart of date range
osid.calendaring.DateTimeendend of date range
booleanmatch true if a positive match, false for negative match
ErrorsINVALID_ARGUMENT start is less than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyEndDate
Description

Matches temporals with any end date set.

Parametersbooleanmatch true to match any end date, false to match no start date
CompliancemandatoryThis method must be implemented.
MethodclearEndDateTerms
Description

Clears the end date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDate
Description

Matches temporals where the given date range falls entirely between the start and end dates inclusive.

Parametersosid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is less than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodclearDateTerms
Description

Clears the date query terms.

CompliancemandatoryThis method must be implemented.