OSID - osid.calendaring.CalendarQuery Service Interface Definition

Interface	osid.calendaring.CalendarQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching calendars. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchEventId
Description	Sets the event `Id` for this query.
Parameters	`osid.id.Id`	`eventId`	an 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.
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. 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 calendar that has any event assigned.
Parameters	`boolean`	`match`	`true` to match calendars with any event, `false` to match calendars 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	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 tiem period query
Errors	UNIMPLEMENTED		`supportsTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodQuery()` is `true.`
Method	matchAnyTimePeriod
Description	Matches a calendar that has any time period assigned.
Parameters	`boolean`	`match`	`true` to match calendars with any time period, `false` to match calendars 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	matchCommitmentId
Description	Sets the commitment `Id` for this query.
Parameters	`osid.id.Id`	`commitmentId`	a commitment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commitmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommitmentIdTerms
Description	Clears the commitment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommitmentQuery
Description	Tests if a `CommitmentQuery` is available.
Return	`boolean`		`true` if a commitment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentQuery
Description	Gets the query for a commitment. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.CommitmentQuery`		the commitment query
Errors	UNIMPLEMENTED		`supportsCommitmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommitmentQuery()` is `true.`
Method	matchAnyCommitment
Description	Matches a calendar that has any event commitment.
Parameters	`boolean`	`match`	`true` to match calendars with any commitment, `false` to match calendars with no commitments
Compliance	`mandatory`		This method must be implemented.
Method	clearCommitmentTerms
Description	Clears the commitment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorCalendarId
Description	Sets the calendar `Id` for this query to match calendars that have the specified calendar as an ancestor.
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	clearAncestorCalendarIdTerms
Description	Clears the ancestor calendar `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorCalendarQuery
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	getAncestorCalendarQuery
Description	Gets the query for a calendar. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.CalendarQuery`		the calendar query
Errors	UNIMPLEMENTED		`supportsAncestorCalendarQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCalndarQuery()` is `true.`
Method	matchAnyAncestorCalendar
Description	Matches a calendar that has any ancestor.
Parameters	`boolean`	`match`	`true` to match calendars with any ancestor, `false` to match root calendars
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCalendarTerms
Description	Clears the ancestor calendar terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantCalendarId
Description	Sets the calendar `Id` for this query to match calendars that have the specified calendar as a descendant.
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	clearDescendantCalendarIdTerms
Description	Clears the descendant calendar `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantCalendarQuery
Description	Tests if a `CalendarQuery.`
Return	`boolean`		`true` if a calendar query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantCalendarQuery
Description	Gets the query for a calendar. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.CalendarQuery`		the calendar query
Errors	UNIMPLEMENTED		`supportsDescendantCalendarQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCalndarQuery()` is `true.`
Method	matchAnyDescendantCalendar
Description	Matches a calendar that has any descendant.
Parameters	`boolean`	`match`	`true` to match calendars with any descendant, `false` to match leaf calendars
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCalendarTerms
Description	Clears the descendant calendar terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarQueryRecord
Description	Gets the calendar query record corresponding to the given `Calendar` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`calendarRecordType`	a calendar record type
Return	`osid.calendaring.records.CalendarQueryRecord`		the calendar query record
Errors	NULL_ARGUMENT		`calendarRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(calendarRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.