OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.ScheduleQueryInspector
Implementsosid.OsidObjectQueryInspector
Description

This is the query inspector for examining schedule queries.

MethodgetScheduleSlotIdTerms
Description

Gets the schedule slot Id terms.

Returnosid.search.terms.IdTerm[]the schedule slot Id terms
CompliancemandatoryThis method must be implemented.
MethodgetScheduleSlotTerms
Description

Gets the schedule slot terms.

Returnosid.calendaring.ScheduleSlotQueryInspector[]the schedule slot terms
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodIdTerms
Description

Gets the time period Id terms.

Returnosid.search.terms.IdTerm[]the time period Id terms
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodTerms
Description

Gets the time period terms.

Returnosid.calendaring.TimePeriodQueryInspector[]the time period terms
CompliancemandatoryThis method must be implemented.
MethodgetScheduleStartTerms
Description

Gets the schedule start terms.

Returnosid.search.terms.DateTimeRangeTerm[]the schedule start terms
CompliancemandatoryThis method must be implemented.
MethodgetScheduleEndTerms
Description

Gets the schedule end terms.

Returnosid.search.terms.DateTimeRangeTerm[]the schedule end terms
CompliancemandatoryThis method must be implemented.
MethodgetScheduleTimeTerms
Description

Gets the schedule time terms.

Returnosid.search.terms.DateTimeTerm[]the schedule time terms
CompliancemandatoryThis method must be implemented.
MethodgetScheduleTimeInclusiveTerms
Description

Gets the schedule inclusive time terms.

Returnosid.search.terms.DateTimeRangeTerm[]the schedule time range terms
CompliancemandatoryThis method must be implemented.
MethodgetLimitTerms
Description

Gets the limit terms.

Returnosid.search.terms.CardinalTerm[]the limit terms
CompliancemandatoryThis method must be implemented.
MethodgetLocationDescriptionTerms
Description

Gets the location description terms.

Returnosid.search.terms.StringTerm[]the location description terms
CompliancemandatoryThis method must be implemented.
MethodgetLocationIdTerms
Description

Gets the location Id terms.

Returnosid.search.terms.IdTerm[]the location Id terms
CompliancemandatoryThis method must be implemented.
MethodgetLocationTerms
Description

Gets the location terms.

Returnosid.mapping.LocationQueryInspector[]the location terms
CompliancemandatoryThis method must be implemented.
MethodgetTotalDurationTerms
Description

Gets the total duration terms.

Returnosid.search.terms.DurationRangeTerm[]the duration terms
CompliancemandatoryThis method must be implemented.
MethodgetCalendarIdTerms
Description

Gets the calendar Id terms.

Returnosid.search.terms.IdTerm[]the calendar Id terms
CompliancemandatoryThis method must be implemented.
MethodgetCalendarTerms
Description

Gets the calendar terms.

Returnosid.calendaring.CalendarQueryInspector[]the calendar terms
CompliancemandatoryThis method must be implemented.
MethodgetScheduleQueryInspectorRecord
Description

Gets the schedule query inspector record corresponding to the given Schedule record Type.

Parametersosid.type.TypescheduleRecordTypea schedule query record type
Returnosid.calendaring.records.ScheduleQueryInspectorRecordthe schedule query inspector record
ErrorsNULL_ARGUMENT scheduleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(scheduleRecordType) is false
CompliancemandatoryThis method must be implemented.