org.osid.calendaring

Interface SupersedingEventQueryInspector

All Superinterfaces:

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

public interface SupersedingEventQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examining superseding event queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar terms.
DateTimeRangeTerm[]	getSupersededDateTerms() Gets the superseded date range terms.
IdTerm[]	getSupersededEventIdTerms() Gets the superseded event Id terms.
IntegerRangeTerm[]	getSupersededEventPositionTerms() Gets the superseded event position terms.
EventQueryInspector[]	getSupersededEventTerms() Gets the superseded event terms.
IdTerm[]	getSupersedingEventIdTerms() Gets the superseding event Id terms.
SupersedingEventQueryInspectorRecord	getSupersedingEventQueryInspectorRecord(Type supersedingEventRecordType) Gets the superseding event query inspector record corresponding to the given SupersedingEvent record Type.
EventQueryInspector[]	getSupersedingEventTerms() Gets the superseding 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

getSupersededEventIdTerms

IdTerm[] getSupersededEventIdTerms()

Gets the superseded event Id terms.

Returns:

the superseded event Id terms

Compliance:

mandatory - This method must be implemented.

getSupersededEventTerms

EventQueryInspector[] getSupersededEventTerms()

Gets the superseded event terms.

Returns:

the superseded event terms

Compliance:

mandatory - This method must be implemented.

getSupersedingEventIdTerms

IdTerm[] getSupersedingEventIdTerms()

Gets the superseding event Id terms.

Returns:

the superseding event Id terms

Compliance:

mandatory - This method must be implemented.

getSupersedingEventTerms

EventQueryInspector[] getSupersedingEventTerms()

Gets the superseding event terms.

Returns:

the superseding event terms

Compliance:

mandatory - This method must be implemented.

getSupersededDateTerms

DateTimeRangeTerm[] getSupersededDateTerms()

Gets the superseded date range terms.

Returns:

the superseded date range terms

Compliance:

mandatory - This method must be implemented.

getSupersededEventPositionTerms

IntegerRangeTerm[] getSupersededEventPositionTerms()

Gets the superseded event position terms.

Returns:

the superseded event position 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.

getSupersedingEventQueryInspectorRecord

SupersedingEventQueryInspectorRecord getSupersedingEventQueryInspectorRecord(Type supersedingEventRecordType)
                                                                             throws OperationFailedException

Gets the superseding event query inspector record corresponding to the given SupersedingEvent record Type.

Parameters:

supersedingEventRecordType - a superseding event query record type

Returns:

the superseding event query inspector record

Throws:

NullArgumentException - supersedingEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventRecordType) is false

Compliance:

mandatory - This method must be implemented.