org.osid.calendaring

Interface CommitmentQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface CommitmentQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining commitment queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar terms.
CommitmentQueryInspectorRecord	getCommitmentQueryInspectorRecord(Type commitmentRecordType) Gets the commitment query inspector record corresponding to the given Commitment record Type.
IdTerm[]	getEventIdTerms() Gets the event Id terms.
EventQueryInspector[]	getEventTerms() Gets the event terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

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.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource terms.

Returns:

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

getCommitmentQueryInspectorRecord

CommitmentQueryInspectorRecord getCommitmentQueryInspectorRecord(Type commitmentRecordType)
                                                                 throws OperationFailedException

Gets the commitment query inspector record corresponding to the given Commitment record Type.

Parameters:

commitmentRecordType - a commitment query record type

Returns:

the commitment query inspector record

Throws:

NullArgumentException - commitmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentRecordType) is false

Compliance:

mandatory - This method must be implemented.