org.osid.calendaring.cycle

Interface CyclicEventQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface CyclicEventQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining event queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar terms.
CyclicEventQueryInspectorRecord	getCyclicEventQueryInspectorRecord(Type cyclicEventRecordType) Gets the cyclic event query inspector record corresponding to the given CyclicEvent record Type.
IdTerm[]	getEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getEventTerms() Gets the event 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

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.

getCyclicEventQueryInspectorRecord

CyclicEventQueryInspectorRecord getCyclicEventQueryInspectorRecord(Type cyclicEventRecordType)
                                                                   throws OperationFailedException

Gets the cyclic event query inspector record corresponding to the given CyclicEvent record Type.

Parameters:

cyclicEventRecordType - a cyclic event query record type

Returns:

the cyclic event query inspector record

Throws:

NullArgumentException - cyclicEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicEventRecordType) is false

Compliance:

mandatory - This method must be implemented.