org.osid.calendaring.cycle

Interface CyclicTimePeriodQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface CyclicTimePeriodQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining cyclic 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.
CyclicTimePeriodQueryInspectorRecord	getCyclicTimePeriodQueryInspectorRecord(Type cyclicTimePeriodRecordType) Gets the cyclic time period query record interface corresponding to the given CyclicTimePeriod record Type.
IdTerm[]	getTimePeriodIdTerms() Gets the time period Id terms.
TimePeriodQueryInspector[]	getTimePeriodTerms() Gets the time period 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

getTimePeriodIdTerms

IdTerm[] getTimePeriodIdTerms()

Gets the time period Id terms.

Returns:

the time period Id terms

Compliance:

mandatory - This method must be implemented.

getTimePeriodTerms

TimePeriodQueryInspector[] getTimePeriodTerms()

Gets the time period terms.

Returns:

the time period 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.

getCyclicTimePeriodQueryInspectorRecord

CyclicTimePeriodQueryInspectorRecord getCyclicTimePeriodQueryInspectorRecord(Type cyclicTimePeriodRecordType)
                                                                             throws OperationFailedException

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

Parameters:

cyclicTimePeriodRecordType - a cyclic time period query record type

Returns:

the cyclic time period query inspector record

Throws:

NullArgumentException - cyclicTimePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicTimePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.