OSID - osid.calendaring.ScheduleQuery Service Interface Definition

Interface	osid.calendaring.ScheduleQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching schedules. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR.`
Method	matchScheduleSlotId
Description	Sets the schedule `Id` for this query for matching nested schedule slots.
Parameters	`osid.id.Id`	`scheduleSlotId`	a schedule slot `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleSlotQuery
Description	Tests if a `ScheduleSlotQuery` is available for querying sechedule slots.
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 `OR` term.
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	matchTimePeriodId
Description	Sets the time period `Id` for this query.
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodIdTerms
Description	Clears the time period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodQuery
Description	Tests if a `TimePeriodQuery` is available.
Return	`boolean`		`true` if a time period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQuery
Description	Gets the query for a time period. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Errors	UNIMPLEMENTED		`supportsTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodQuery()` is `true.`
Method	matchAnyTimePeriod
Description	Matches a schedule that has any time period assigned.
Parameters	`boolean`	`match`	`true` to match schedules with any time periods, `false` to match schedules with no time periods
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodTerms
Description	Clears the time period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScheduleStart
Description	Matches the schedule start time between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low time range
	`osid.calendaring.DateTime`	`high`	high time range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Errors	NULL_ARGUMENT		`high` or `low` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyScheduleStart
Description	Matches a schedule that has any start time assigned.
Parameters	`boolean`	`match`	`true` to match schedules with any start time, `false` to match schedules with no start time
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleStartTerms
Description	Clears the schedule start terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScheduleEnd
Description	Matches the schedule end time between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`low`	low time range
	`osid.calendaring.DateTime`	`high`	high time range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Errors	NULL_ARGUMENT		`high` or `low` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyScheduleEnd
Description	Matches a schedule that has any end time assigned.
Parameters	`boolean`	`match`	`true` to match schedules with any end time, `false` to match schedules with no start time
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleEndTerms
Description	Clears the schedule end terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScheduleTime
Description	Matches schedules with start and end times between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`date`	a date
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyScheduleTime
Description	Matches schedules that has any time assigned.
Parameters	`boolean`	`match`	`true` to match schedules with any time, `false` to match schedules with no time
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleTimeTerms
Description	Clears the schedule time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScheduleTimeInclusive
Description	Matches schedules with start and end times between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start date
	`osid.calendaring.DateTime`	`end`	end date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`end` or `start` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleTimeInclusiveTerms
Description	Clears the schedule time inclusive terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLimit
Description	Matches schedules that have the given limit 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	matchAnyLimit
Description	Matches schedules with any occurrence limit.
Parameters	`boolean`	`match`	`true` to match schedules with any limit, to match schedules with no limit
Compliance	`mandatory`		This method must be implemented.
Method	clearLimitTerms
Description	Clears the limit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationDescription
Description	Matches the location description string.
Parameters	`string`	`location`	location string
	`osid.type.Type`	`stringMatchType`	string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`location` is not of `stringMatchType`
	NULL_ARGUMENT		`location` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyLocationDescription
Description	Matches a schedule that has any location description assigned.
Parameters	`boolean`	`match`	`true` to match schedules with any location description, `false` to match schedules with no location description
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationDescriptionTerms
Description	Clears the location description terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationId
Description	Sets the location `Id` for this query.
Parameters	`osid.id.Id`	`locationId`	a location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationIdTerms
Description	Clears the location `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationQuery
Description	Tests if a `LocationQuery` is available for querying locations.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQuery
Description	Gets the query for a location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationQuery()` is `true.`
Method	matchAnyLocation
Description	Matches a schedule that has any location assigned.
Parameters	`boolean`	`match`	`true` to match schedules with any location, `false` to match schedules with no location
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationTerms
Description	Clears the location terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTotalDuration
Description	Matches the total 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`
Errors	NULL_ARGUMENT		`high` or `low` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalDurationTerms
Description	Clears the total duration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCalendarId
Description	Sets the calendar `Id` for this query.
Parameters	`osid.id.Id`	`calendarId`	a calendar `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarQuery
Description	Tests if a `CalendarQuery` is available for querying calendars.
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 `OR` term.
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	getScheduleQueryRecord
Description	Gets the schedule query record corresponding to the given `Schedule` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`scheduleRecordType`	a schedule query record type
Return	`osid.calendaring.records.ScheduleQueryRecord`		the schedule query record
Errors	NULL_ARGUMENT		`scheduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(scheduleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.