org.osid.calendaring

Interface OffsetEventQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface OffsetEventQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examining offset event queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar terms.
IdTerm[]	getEndReferenceEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getEndReferenceEventTerms() Gets the event terms.
DurationRangeTerm[]	getFixedDurationTerms() Gets the fixed duration terms.
IntegerRangeTerm[]	getFixedEndOffsetTerms() Gets the fixed offset terms.
IntegerRangeTerm[]	getFixedStartOffsetTerms() Gets the fixed offset terms.
DateTimeRangeTerm[]	getFixedStartTimeTerms() Gets the fixed start time terms.
StringTerm[]	getLocationDescriptionTerms() Gets the location description terms.
IdTerm[]	getLocationIdTerms() Gets the location Id terms.
LocationQueryInspector[]	getLocationTerms() Gets the location terms.
OffsetEventQueryInspectorRecord	getOffsetEventQueryInspectorRecord(Type offsetEventRecordType) Gets the offset event query inspector record corresponding to the given OffsetEvent record Type.
CardinalTerm[]	getRelativeEndWeekdayTerms() Gets the relative weekday terms.
CardinalTerm[]	getRelativeStartWeekdayTerms() Gets the relative weekday terms.
IntegerRangeTerm[]	getRelativeWeekdayEndOffsetTerms() Gets the relative weekday offset terms.
IntegerRangeTerm[]	getRelativeWeekdayStartOffsetTerms() Gets the relative weekday offset terms.
IdTerm[]	getSponsorIdTerms() Gets the sponsor Id terms.
ResourceQueryInspector[]	getSponsorTerms() Gets the sponsor terms.
IdTerm[]	getStartReferenceEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getStartReferenceEventTerms() Gets the event terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getFixedStartTimeTerms

DateTimeRangeTerm[] getFixedStartTimeTerms()

Gets the fixed start time terms.

Returns:

the fixed start time terms

Compliance:

mandatory - This method must be implemented.

getStartReferenceEventIdTerms

IdTerm[] getStartReferenceEventIdTerms()

Gets the event Id terms.

Returns:

the event Id terms

Compliance:

mandatory - This method must be implemented.

getStartReferenceEventTerms

EventQueryInspector[] getStartReferenceEventTerms()

Gets the event terms.

Returns:

the event terms

Compliance:

mandatory - This method must be implemented.

getFixedStartOffsetTerms

IntegerRangeTerm[] getFixedStartOffsetTerms()

Gets the fixed offset terms.

Returns:

the fixed offset terms

Compliance:

mandatory - This method must be implemented.

getRelativeWeekdayStartOffsetTerms

IntegerRangeTerm[] getRelativeWeekdayStartOffsetTerms()

Gets the relative weekday offset terms.

Returns:

the relative weekday offset terms

Compliance:

mandatory - This method must be implemented.

getRelativeStartWeekdayTerms

CardinalTerm[] getRelativeStartWeekdayTerms()

Gets the relative weekday terms.

Returns:

the relative weekday terms

Compliance:

mandatory - This method must be implemented.

getFixedDurationTerms

DurationRangeTerm[] getFixedDurationTerms()

Gets the fixed duration terms.

Returns:

the fixed duration terms

Compliance:

mandatory - This method must be implemented.

getEndReferenceEventIdTerms

IdTerm[] getEndReferenceEventIdTerms()

Gets the event Id terms.

Returns:

the event Id terms

Compliance:

mandatory - This method must be implemented.

getEndReferenceEventTerms

EventQueryInspector[] getEndReferenceEventTerms()

Gets the event terms.

Returns:

the event terms

Compliance:

mandatory - This method must be implemented.

getFixedEndOffsetTerms

IntegerRangeTerm[] getFixedEndOffsetTerms()

Gets the fixed offset terms.

Returns:

the fixed offset terms

Compliance:

mandatory - This method must be implemented.

getRelativeWeekdayEndOffsetTerms

IntegerRangeTerm[] getRelativeWeekdayEndOffsetTerms()

Gets the relative weekday offset terms.

Returns:

the relative weekday offset terms

Compliance:

mandatory - This method must be implemented.

getRelativeEndWeekdayTerms

CardinalTerm[] getRelativeEndWeekdayTerms()

Gets the relative weekday terms.

Returns:

the relative weekday terms

Compliance:

mandatory - This method must be implemented.

getLocationDescriptionTerms

StringTerm[] getLocationDescriptionTerms()

Gets the location description terms.

Returns:

the location description terms

Compliance:

mandatory - This method must be implemented.

getLocationIdTerms

IdTerm[] getLocationIdTerms()

Gets the location Id terms.

Returns:

the location Id terms

Compliance:

mandatory - This method must be implemented.

getLocationTerms

LocationQueryInspector[] getLocationTerms()

Gets the location terms.

Returns:

the location terms

Compliance:

mandatory - This method must be implemented.

getSponsorIdTerms

IdTerm[] getSponsorIdTerms()

Gets the sponsor Id terms.

Returns:

the sponsor Id terms

Compliance:

mandatory - This method must be implemented.

getSponsorTerms

ResourceQueryInspector[] getSponsorTerms()

Gets the sponsor terms.

Returns:

the sponsor 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.

getOffsetEventQueryInspectorRecord

OffsetEventQueryInspectorRecord getOffsetEventQueryInspectorRecord(Type offsetEventRecordType)
                                                                   throws OperationFailedException

Gets the offset event query inspector record corresponding to the given OffsetEvent record Type.

Parameters:

offsetEventRecordType - an offset event query record type

Returns:

the offset event query inspector record

Throws:

NullArgumentException - offsetEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventRecordType) is false

Compliance:

mandatory - This method must be implemented.