org.osid.calendaring

Interface TimePeriodQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface TimePeriodQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining time period queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar terms.
DurationTerm[]	getDurationTerms() Gets the duration terms.
DateTimeTerm[]	getEndTerms() Gets the end terms.
IdTerm[]	getEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getEventTerms() Gets the event terms.
IdTerm[]	getExceptionIdTerms() Gets the exception event Id terms.
EventQueryInspector[]	getExceptionTerms() Gets the exception event terms.
DateTimeTerm[]	getStartTerms() Gets the start terms.
DateTimeRangeTerm[]	getTimeInclusiveTerms() Gets the inclusive time terms.
TimePeriodQueryInspectorRecord	getTimePeriodQueryInspectorRecord(Type timePeriodRecordType) Gets the time period query record interface corresponding to the given TimePeriod record Type.
DateTimeTerm[]	getTimeTerms() Gets the time terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getStartTerms

DateTimeTerm[] getStartTerms()

Gets the start terms.

Returns:

the start terms

Compliance:

mandatory - This method must be implemented.

getEndTerms

DateTimeTerm[] getEndTerms()

Gets the end terms.

Returns:

the end terms

Compliance:

mandatory - This method must be implemented.

getTimeTerms

DateTimeTerm[] getTimeTerms()

Gets the time terms.

Returns:

the time terms

Compliance:

mandatory - This method must be implemented.

getTimeInclusiveTerms

DateTimeRangeTerm[] getTimeInclusiveTerms()

Gets the inclusive time terms.

Returns:

the time range terms

Compliance:

mandatory - This method must be implemented.

getDurationTerms

DurationTerm[] getDurationTerms()

Gets the duration terms.

Returns:

the duration terms

Compliance:

mandatory - This method must be implemented.

getExceptionIdTerms

IdTerm[] getExceptionIdTerms()

Gets the exception event Id terms.

Returns:

the exception event Id terms

Compliance:

mandatory - This method must be implemented.

getExceptionTerms

EventQueryInspector[] getExceptionTerms()

Gets the exception event terms.

Returns:

the exception event terms

Compliance:

mandatory - This method must be implemented.

getEventIdTerms

IdTerm[] getEventIdTerms()

Gets the event Id terms.

Returns:

the event Id terms

Compliance:

mandatory - This method must be implemented.

getEventTerms

EventQueryInspector[] getEventTerms()

Gets the event terms.

Returns:

the event terms

Compliance:

mandatory - This method must be implemented.

getCalendarIdTerms

IdTerm[] getCalendarIdTerms()

Gets the calendar Id terms.

Returns:

the calendar Id terms

Compliance:

mandatory - This method must be implemented.

getCalendarTerms

CalendarQueryInspector[] getCalendarTerms()

Gets the calendar terms.

Returns:

the calendar terms

Compliance:

mandatory - This method must be implemented.

getTimePeriodQueryInspectorRecord

TimePeriodQueryInspectorRecord getTimePeriodQueryInspectorRecord(Type timePeriodRecordType)
                                                                 throws OperationFailedException

Gets the time period query record interface corresponding to the given TimePeriod record Type.

Parameters:

timePeriodRecordType - a time period query record type

Returns:

the time period query inspector record

Throws:

NullArgumentException - timePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.