OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.ScheduleSlotQuery
Implementsosid.OsidObjectQuery
osid.OsidContainableQuery
Description

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

MethodmatchScheduleSlotId
Description

Sets the schedule Id for this query for matching nested schedule slots.

Parametersosid.id.IdscheduleSlotIda schedule slot Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT scheduleSlotId is null
CompliancemandatoryThis method must be implemented.
MethodclearScheduleSlotIdTerms
Description

Clears the schedule slot Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsScheduleSlotQuery
Description

Tests if a ScheduleSlotQuery is available for querying sechedule slots.

Returnboolean true if a schedule slot query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotQuery
Description

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

Returnosid.calendaring.ScheduleSlotQuerythe schedule slot query
ErrorsUNIMPLEMENTED supportsScheduleSlotQuery() is false
ComplianceoptionalThis method must be implemented if supportsScheduleSlotQuery() is true.
MethodmatchAnyScheduleSlot
Description

Matches a schedule that has any schedule slot assigned.

Parametersbooleanmatch true to match schedule with any schedule slots, false to match schedules with no schedule slots
CompliancemandatoryThis method must be implemented.
MethodclearScheduleSlotTerms
Description

Clears the schedule slot terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeekday
Description

Matches schedules that have the given weekday.

Parameterscardinalweekdaya weekday
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeekday
Description

Matches schedules with any weekday set.

Parametersbooleanmatch true to match schedules with any weekday, false to match schedules with no weekday
CompliancemandatoryThis method must be implemented.
MethodclearWeekdayTerms
Description

Clears the weekday terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyInterval
Description

Matches schedules that have the given weekly interval in the given range inclusive.

Parametersintegerfromstart range
integertoend range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyInterval
Description

Matches schedules with any weekly interval set.

Parametersbooleanmatch true to match schedules with any weekly interval, false to match schedules with no weekly interval
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyIntervalTerms
Description

Clears the weekly interval terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeekOfMonth
Description

Matches schedules that have a week of month in the given range inclusive.

Parametersintegerfromstart range
integertoend range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeekOfMonth
Description

Matches schedules with any month week set.

Parametersbooleanmatch true to match schedules with any week of month, false to match schedules with no month week
CompliancemandatoryThis method must be implemented.
MethodclearWeekOfMonthTerms
Description

Clears the week of month terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeekdayTime
Description

Matches schedules that have a weekday time in the given range inclusive.

Parametersosid.calendaring.Timefromstart range
osid.calendaring.Timetoend range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT from or to null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeekdayTime
Description

Matches schedules with any weekday time.

Parametersbooleanmatch true to match schedules with any weekday time, false to match schedules with no weekday time
CompliancemandatoryThis method must be implemented.
MethodclearWeekdayTimeTerms
Description

Clears the weekday time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFixedInterval
Description

Matches schedules that have the given fixed interval in the given range inclusive.

Parametersosid.calendaring.Durationfromstart range
osid.calendaring.Durationtoend range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT from or to null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyFixedInterval
Description

Matches schedules with any fixed interval.

Parametersbooleanmatch true to match schedules with any fixed interval, false to match schedules with no fixed interval
CompliancemandatoryThis method must be implemented.
MethodclearFixedIntervalTerms
Description

Clears the fixed interval terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDuration
Description

Matches the 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.
MethodmatchAnyDuration
Description

Matches a schedule slot that has any duration.

Parametersbooleanmatch true to match schedules with any duration, false to match schedules with no start time
CompliancemandatoryThis method must be implemented.
MethodclearDurationTerms
Description

Clears the duration 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 calendars.

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.
MethodgetScheduleSlotQueryRecord
Description

Gets the schedule slot query record corresponding to the given ScheduleSlot record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypescheduleSlotRecordTypea schedule slot query record type
Returnosid.calendaring.records.ScheduleSlotQueryRecordthe schedule slot query record
ErrorsNULL_ARGUMENT scheduleSlotRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(scheduleSlotRecordType) is false
CompliancemandatoryThis method must be implemented.