OSID - osid.calendaring.TimePeriodQueryInspector Service Interface Definition

Interface	osid.calendaring.TimePeriodQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Used By	`osid.OsidEnablerQueryInspector`
	`osid.calendaring.CalendarQueryInspector`
	`osid.calendaring.ScheduleQueryInspector`
	`osid.calendaring.TimePeriodSearchResults`
	`osid.calendaring.TimePeriodSmartCalendarSession`
	`osid.calendaring.cycle.CyclicTimePeriodQueryInspector`
	`osid.offering.OfferingQueryInspector`
	`osid.offering.ParticipantQueryInspector`
	`osid.recognition.ConvocationQueryInspector`
Description	This is the query inspector for examining time period queries. Like all `OsidQueryInspectors`, `TimePeriodQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getStartTerms
Description	Gets the start terms.
Return	`osid.search.terms.DateTimeTerm[]`		the start terms
Compliance	`mandatory`		This method must be implemented.
Method	getEndTerms
Description	Gets the end terms.
Return	`osid.search.terms.DateTimeTerm[]`		the end terms
Compliance	`mandatory`		This method must be implemented.
Method	getTimeTerms
Description	Gets the time terms.
Return	`osid.search.terms.DateTimeTerm[]`		the time terms
Compliance	`mandatory`		This method must be implemented.
Method	getTimeInclusiveTerms
Description	Gets the inclusive time terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the time range terms
Compliance	`mandatory`		This method must be implemented.
Method	getDurationTerms
Description	Gets the duration terms.
Return	`osid.search.terms.DurationTerm[]`		the duration terms
Compliance	`mandatory`		This method must be implemented.
Method	getExceptionIdTerms
Description	Gets the exception event `Id` terms.
Return	`osid.search.terms.IdTerm[]`		the exception event `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getExceptionTerms
Description	Gets the exception event terms.
Return	`osid.calendaring.EventQueryInspector[]`		the exception event terms
Compliance	`mandatory`		This method must be implemented.
Method	getEventIdTerms
Description	Gets the event `Id` terms.
Return	`osid.search.terms.IdTerm[]`		the event `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getEventTerms
Description	Gets the event terms.
Return	`osid.calendaring.EventQueryInspector[]`		the event terms
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarIdTerms
Description	Gets the calendar `Id` terms.
Return	`osid.search.terms.IdTerm[]`		the calendar `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarTerms
Description	Gets the calendar terms.
Return	`osid.calendaring.CalendarQueryInspector[]`		the calendar terms
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQueryInspectorRecord
Description	Gets the time period query record interface corresponding to the given `TimePeriod` record `Type`.
Parameters	`osid.type.Type`	`timePeriodRecordType`	a time period query record type
Return	`osid.calendaring.records.TimePeriodQueryInspectorRecord`		the time period query inspector 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.