org.osid.calendaring

Interface CalendarQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface CalendarQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining calendar queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorCalendarIdTerms() Gets the ancestor calendar Id terms.
CalendarQueryInspector[]	getAncestorCalendarTerms() Gets the ancestor calendar terms.
CalendarQueryInspectorRecord	getCalendarQueryInspectorRecord(Type calendarRecordType) Gets the calendar query inspector record corresponding to the given Calendar record Type.
IdTerm[]	getCommitmentIdTerms() Gets the commitment Id terms.
CommitmentQueryInspector[]	getCommitmentTerms() Gets the commitment terms.
IdTerm[]	getDescendantCalendarIdTerms() Gets the descendant calendar Id terms.
CalendarQueryInspector[]	getDescendantCalendarTerms() Gets the descendant calendar terms.
IdTerm[]	getEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getEventTerms() Gets the event terms.
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

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

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.

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.

getCommitmentIdTerms

IdTerm[] getCommitmentIdTerms()

Gets the commitment Id terms.

Returns:

the commitment Id terms

Compliance:

mandatory - This method must be implemented.

getCommitmentTerms

CommitmentQueryInspector[] getCommitmentTerms()

Gets the commitment terms.

Returns:

the commitment terms

Compliance:

mandatory - This method must be implemented.

getAncestorCalendarIdTerms

IdTerm[] getAncestorCalendarIdTerms()

Gets the ancestor calendar Id terms.

Returns:

the ancestor calendar Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorCalendarTerms

CalendarQueryInspector[] getAncestorCalendarTerms()

Gets the ancestor calendar terms.

Returns:

the ancestor calendar terms

Compliance:

mandatory - This method must be implemented.

getDescendantCalendarIdTerms

IdTerm[] getDescendantCalendarIdTerms()

Gets the descendant calendar Id terms.

Returns:

the descendant calendar Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantCalendarTerms

CalendarQueryInspector[] getDescendantCalendarTerms()

Gets the descendant calendar terms.

Returns:

the descendant calendar terms

Compliance:

mandatory - This method must be implemented.

getCalendarQueryInspectorRecord

CalendarQueryInspectorRecord getCalendarQueryInspectorRecord(Type calendarRecordType)
                                                             throws OperationFailedException

Gets the calendar query inspector record corresponding to the given Calendar record Type.

Parameters:

calendarRecordType - a calendar record type

Returns:

the calendar query inspector record

Throws:

NullArgumentException - calendarRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarRecordType) is false

Compliance:

mandatory - This method must be implemented.