OSID - osid.calendaring.rules.OffsetEventEnablerQuery Service Interface Definition

Interface	osid.calendaring.rules.OffsetEventEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.calendaring.rules.OffsetEventEnablerQuerySession`
	`osid.calendaring.rules.OffsetEventEnablerSearchSession`
	`osid.calendaring.rules.OffsetEventEnablerSmartCalendarSession`
Description	This is the query for searching offset event enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledOffsetEventId
Description	Matches enablers mapped to the offset event.
Parameters	`osid.id.Id`	`offsetEventId`	the offset event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`offsetEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledOffsetEventIdTerms
Description	Clears the offset event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledOffsetEventQuery
Description	Tests if an `OffsetEventQuery` is available.
Return	`boolean`		`true` if an offset event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledOffsetEventQuery
Description	Gets the query for an offset event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.OffsetEventQuery`		the offset event query
Errors	UNIMPLEMENTED		`supportsRuledOffsetEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledOffsetEventQuery()` is `true`.
Method	matchAnyRuledOffsetEvent
Description	Matches enablers mapped to any offset event.
Parameters	`boolean`	`match`	`true` for enablers mapped to any offset event, `false` to match enablers mapped to no offset events
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledOffsetEventTerms
Description	Clears the offset event query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCalendarId
Description	Matches enablers mapped to the calendar.
Parameters	`osid.id.Id`	`calendarId`	the 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` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarQuery
Description	Tests if a `CalendarQuery` is available.
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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablerQueryRecord
Description	Gets the offset event enabler query record corresponding to the given `OffsetEventEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`offsetEventEnablerRecordType`	an offset event enabler record type
Return	`osid.calendaring.rules.records.OffsetEventEnablerQueryRecord`		the offset event enabler query record
Errors	NULL_ARGUMENT		`offsetEventEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offsetEventEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.