OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.TimePeriodQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching time periods. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchStart
Description

Matches the time period start time between the given range inclusive.

Parametersosid.calendaring.DateTimelowlow time range
osid.calendaring.DateTimehighhigh time range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT high is less than low
NULL_ARGUMENT high or low is zero
CompliancemandatoryThis method must be implemented.
MethodmatchAnyStart
Description

Matches a time period that has any start time assigned.

Parametersbooleanmatch true to match time periods with any start time, false to match time periods with no start time
CompliancemandatoryThis method must be implemented.
MethodclearStartTerms
Description

Clears the time period start terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEnd
Description

Matches the time period end time between the given range inclusive.

Parametersosid.calendaring.DateTimelowlow time range
osid.calendaring.DateTimehighhigh time range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT high is less than low
NULL_ARGUMENT high or low is zero
CompliancemandatoryThis method must be implemented.
MethodmatchAnyEnd
Description

Matches a time period that has any end time assigned.

Parametersbooleanmatch true to match time periods with any end time, false to match time periods with no end time
CompliancemandatoryThis method must be implemented.
MethodclearEndTerms
Description

Clears the time period end terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTime
Description

Matches time periods that include the given time.

Parametersosid.calendaring.DateTimetimedate
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTime
Description

Matches a time period that has any time assigned.

Parametersbooleanmatch true to match time periods with any time, false to match time periods with no time
CompliancemandatoryThis method must be implemented.
MethodclearTimeTerms
Description

Clears the time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeInclusive
Description

Matches time periods with start and end times between the given range inclusive.

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

Clears the time inclusive terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDuration
Description

Matches the time period duration between the given range inclusive.

Parametersosid.calendaring.Durationlowlow duration range
osid.calendaring.Durationhighhigh duration range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT high is less than low
NULL_ARGUMENT high or low is null
CompliancemandatoryThis method must be implemented.
MethodclearDurationTerms
Description

Clears the duration terms.

CompliancemandatoryThis method must be implemented.
MethodmatchExceptionId
Description

Sets the event Id for this query to match exceptions.

Parametersosid.id.IdeventIdan exception event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearExceptionIdTerms
Description

Clears the exception event Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsExceptionQuery
Description

Tests if an EventQuery is available for querying exception events.

Returnboolean true if a exception query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetExceptionQuery
Description

Gets the query for an exception event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsExceptionQuery() is false
ComplianceoptionalThis method must be implemented if supportsExceptionQuery() is true.
MethodmatchAnyException
Description

Matches a time period that has any exception event assigned.

Parametersbooleanmatch true to match time periods with any exception, false to match time periods with no exception
CompliancemandatoryThis method must be implemented.
MethodclearExceptionTerms
Description

Clears the exception event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEventId
Description

Sets the event Id for this query.

Parametersosid.id.IdeventIdan event or recurring event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearEventIdTerms
Description

Clears the event Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEventQuery
Description

Tests if an EventQuery is available for querying events.

Returnboolean true if an event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEventQuery
Description

Gets the query for an event or recurring event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsEventQuery() is true.
MethodmatchAnyEvent
Description

Matches a time period that has any event assigned.

Parametersbooleanmatch true to match time periods with any event, false to match time periods with no events
CompliancemandatoryThis method must be implemented.
MethodclearEventTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCalendarId
Description

Sets the calendar Id for this query.

Parametersosid.id.IdcalendarIda calendar Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT calendarId is null
CompliancemandatoryThis method must be implemented.
MethodclearCalendarIdTerms
Description

Clears the calendar Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCalendarQuery
Description

Tests if a CalendarQuery is available for querying resources.

Returnboolean true if a calendar query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCalendarQuery
Description

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.CalendarQuerythe calendar query
ErrorsUNIMPLEMENTED supportsCalendarQuery() is false
ComplianceoptionalThis method must be implemented if supportsCalendarQuery() is true.
MethodclearCalendarTerms
Description

Clears the calendar terms.

CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodQueryRecord
Description

Gets the time period query record corresponding to the given TimePeriod record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypetimePeriodRecordTypea time period query record type
Returnosid.calendaring.records.TimePeriodQueryRecordthe time period query record
ErrorsNULL_ARGUMENT timePeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(timePeriodRecordType) is false
CompliancemandatoryThis method must be implemented.