OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidCompendiumQuery
Implementsosid.OsidObjectQuery
osid.OsidSubjugateableQuery
Description

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

MethodmatchStartDate
Description

Matches reports 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 reports 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 reports 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 reports 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.
MethodmatchInterpolated
Description

Match reports that are interpolated.

Parametersbooleanmatch true to match any interpolated reports, false to match non-interpolated reports
CompliancemandatoryThis method must be implemented.
MethodclearInterpolatedTerms
Description

Clears the interpolated query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchExtrapolated
Description

Match reports that are extrapolated.

Parametersbooleanmatch true to match any extrapolated reports, false to match non-extrapolated reports
CompliancemandatoryThis method must be implemented.
MethodclearExtrapolatedTerms
Description

Clears the extrapolated query terms.

CompliancemandatoryThis method must be implemented.