Interface | osid.calendaring.ScheduleSlotQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidContainableQuery | |||
Description |
This is the query for searching schedule slots. Each method
match request produces an | ||
Method | matchScheduleSlotId | ||
Description |
Sets the schedule | ||
Parameters | osid.id.Id | scheduleSlotId | a schedule slot Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | scheduleSlotId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleSlotIdTerms | ||
Description |
Clears the schedule slot | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsScheduleSlotQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a schedule slot query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleSlotQuery | ||
Description |
Gets the query for a schedul slot. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.ScheduleSlotQuery | the schedule slot query | |
Errors | UNIMPLEMENTED | supportsScheduleSlotQuery() is false | |
Compliance | optional | This method must be implemented if supportsScheduleSlotQuery()
is true. | |
Method | matchAnyScheduleSlot | ||
Description |
Matches a schedule that has any schedule slot assigned. | ||
Parameters | boolean | match | true to match schedule with any schedule slots, false
to match schedules with no schedule slots |
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleSlotTerms | ||
Description |
Clears the schedule slot terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeekday | ||
Description |
Matches schedules that have the given weekday. | ||
Parameters | cardinal | weekday | a weekday |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeekday | ||
Description |
Matches schedules with any weekday set. | ||
Parameters | boolean | match | true to match schedules with any weekday, false
to match schedules with no weekday |
Compliance | mandatory | This method must be implemented. | |
Method | clearWeekdayTerms | ||
Description |
Clears the weekday terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeeklyInterval | ||
Description |
Matches schedules that have the given weekly interval in the given range inclusive. | ||
Parameters | integer | from | start range |
integer | to | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | to is less than from | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeeklyInterval | ||
Description |
Matches schedules with any weekly interval set. | ||
Parameters | boolean | match | true to match schedules with any weekly interval,
false to match schedules with no weekly interval |
Compliance | mandatory | This method must be implemented. | |
Method | clearWeeklyIntervalTerms | ||
Description |
Clears the weekly interval terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeekOfMonth | ||
Description |
Matches schedules that have a week of month in the given range inclusive. | ||
Parameters | integer | from | start range |
integer | to | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | to is less than from | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeekOfMonth | ||
Description |
Matches schedules with any month week set. | ||
Parameters | boolean | match | true to match schedules with any week of month, false
to match schedules with no month week |
Compliance | mandatory | This method must be implemented. | |
Method | clearWeekOfMonthTerms | ||
Description |
Clears the week of month terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeekdayTime | ||
Description |
Matches schedules that have a weekday time in the given range inclusive. | ||
Parameters | osid.calendaring.Time | from | start range |
osid.calendaring.Time | to | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | from or to null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeekdayTime | ||
Description |
Matches schedules with any weekday time. | ||
Parameters | boolean | match | true to match schedules with any weekday time, false
to match schedules with no weekday time |
Compliance | mandatory | This method must be implemented. | |
Method | clearWeekdayTimeTerms | ||
Description |
Clears the weekday time terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFixedInterval | ||
Description |
Matches schedules that have the given fixed interval in the given range inclusive. | ||
Parameters | osid.calendaring.Duration | from | start range |
osid.calendaring.Duration | to | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | from or to null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyFixedInterval | ||
Description |
Matches schedules with any fixed interval. | ||
Parameters | boolean | match | true to match schedules with any fixed interval,
false to match schedules with no fixed interval |
Compliance | mandatory | This method must be implemented. | |
Method | clearFixedIntervalTerms | ||
Description |
Clears the fixed interval terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDuration | ||
Description |
Matches the duration between the given range inclusive. | ||
Parameters | osid.calendaring.Duration | low | low duration range |
osid.calendaring.Duration | high | high duration range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | high is less than low | |
NULL_ARGUMENT | high or low is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyDuration | ||
Description |
Matches a schedule slot that has any duration. | ||
Parameters | boolean | match | true to match schedules with any duration, false
to match schedules with no start time |
Compliance | mandatory | This method must be implemented. | |
Method | clearDurationTerms | ||
Description |
Clears the duration terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCalendarId | ||
Description |
Sets the calendar | ||
Parameters | osid.id.Id | calendarId | a calendar Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | calendarId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCalendarIdTerms | ||
Description |
Clears the calendar | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCalendarQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a calendar query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarQuery | ||
Description |
Gets the query for a calendar. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.CalendarQuery | the calendar query | |
Errors | UNIMPLEMENTED | supportsCalendarQuery() is false | |
Compliance | optional | This method must be implemented if supportsCalendarQuery()
is true. | |
Method | clearCalendarTerms | ||
Description |
Clears the calendar terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleSlotQueryRecord | ||
Description |
Gets the schedule slot query record corresponding to
the given | ||
Parameters | osid.type.Type | scheduleSlotRecordType | a schedule slot query record type |
Return | osid.calendaring.records.ScheduleSlotQueryRecord | the schedule slot query record | |
Errors | NULL_ARGUMENT | scheduleSlotRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(scheduleSlotRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |