OSID - osid.calendaring.TimePeriodQuery Service Interface Definition

Interface	osid.calendaring.TimePeriodQuery
Implements	`osid.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.`
Method	matchStart
Description	Matches the time period 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 `zero`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStart
Description	Matches a time period that has any start time assigned.
Parameters	`boolean`	`match`	`true` to match time periods with any start time, `false` to match time periods with no start time
Compliance	`mandatory`		This method must be implemented.
Method	clearStartTerms
Description	Clears the time period start terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEnd
Description	Matches the time period 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 `zero`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyEnd
Description	Matches a time period that has any end time assigned.
Parameters	`boolean`	`match`	`true` to match time periods with any end time, `false` to match time periods with no end time
Compliance	`mandatory`		This method must be implemented.
Method	clearEndTerms
Description	Clears the time period end terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTime
Description	Matches time periods that include the given time.
Parameters	`osid.calendaring.DateTime`	`time`	date
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTime
Description	Matches a time period that has any time assigned.
Parameters	`boolean`	`match`	`true` to match time periods with any time, `false` to match time periods with no time
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeTerms
Description	Clears the time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeInclusive
Description	Matches time periods 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		`start` or `end` is `zero`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeInclusiveTerms
Description	Clears the time inclusive terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDuration
Description	Matches the time period 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	clearDurationTerms
Description	Clears the duration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExceptionId
Description	Sets the event `Id` for this query to match exceptions.
Parameters	`osid.id.Id`	`eventId`	an exception event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExceptionIdTerms
Description	Clears the exception event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsExceptionQuery
Description	Tests if an `EventQuery` is available for querying exception events.
Return	`boolean`		`true` if a exception query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExceptionQuery
Description	Gets the query for an exception event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsExceptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsExceptionQuery()` is `true.`
Method	matchAnyException
Description	Matches a time period that has any exception event assigned.
Parameters	`boolean`	`match`	`true` to match time periods with any exception, `false` to match time periods with no exception
Compliance	`mandatory`		This method must be implemented.
Method	clearExceptionTerms
Description	Clears the exception event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEventId
Description	Sets the event `Id` for this query.
Parameters	`osid.id.Id`	`eventId`	an event or recurring event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEventIdTerms
Description	Clears the event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventQuery
Description	Tests if an `EventQuery` is available for querying events.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventQuery
Description	Gets the query for an event or recurring event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventQuery()` is `true.`
Method	matchAnyEvent
Description	Matches a time period that has any event assigned.
Parameters	`boolean`	`match`	`true` to match time periods with any event, `false` to match time periods with no events
Compliance	`mandatory`		This method must be implemented.
Method	clearEventTerms
Description	Clears the event 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 resources.
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	getTimePeriodQueryRecord
Description	Gets the time period query record corresponding to the given `TimePeriod` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`timePeriodRecordType`	a time period query record type
Return	`osid.calendaring.records.TimePeriodQueryRecord`		the time period query record
Errors	NULL_ARGUMENT		`timePeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(timePeriodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.