OSID - osid.calendaring.cycle.CyclicTimePeriodQuery Service Interface Definition

Interface	osid.calendaring.cycle.CyclicTimePeriodQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.OsidEnablerQuery`
	`osid.calendaring.cycle.CyclicTimePeriodQuerySession`
	`osid.calendaring.cycle.CyclicTimePeriodSearchSession`
	`osid.calendaring.cycle.CyclicTimePeriodSmartCalendarSession`
	`osid.offering.CanonicalUnitQuery`
Description	This is the query for searching cyclic time periods. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchTimePeriodId
Description	Sets the time period `Id` for this query to match cyclic time periods with the given mapped time period.
Parameters	`osid.id.Id`	`timePeriodId`	a tiem 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 cyclic time period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodQuery
Description	Tests if a `TimePeriodQuery` is available for querying time periods.
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 cyclic time period that has any time period assigned.
Parameters	`boolean`	`match`	`true` to match cyclic time periods with any tiem period, `false` to match cyclic time periods with no tiem periods
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodTerms
Description	Clears the time period 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	getCyclicTimePeriodQueryRecord
Description	Gets the cyclic time period query record corresponding to the given `CyclicTimePeriod` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`cyclicTimePeriodRecordType`	a cyclic time period query record type
Return	`osid.calendaring.cycle.records.CyclicTimePeriodQueryRecord`		the cyclic time period query record
Errors	NULL_ARGUMENT		`cyclicTimePeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(cyclicTimePeriodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.