org.osid.calendaring.rules

Interface CommitmentEnablerQueryInspector

All Superinterfaces:

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

public interface CommitmentEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining commitment enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCalendarIdTerms() Gets the calendar Id query terms.
CalendarQueryInspector[]	getCalendarTerms() Gets the calendar query terms.
CommitmentEnablerQueryInspectorRecord	getCommitmentEnablerQueryInspectorRecord(Type commitmentEnablerRecordType) Gets the commitment enabler query inspector record corresponding to the given CommitmentEnabler record Type.
IdTerm[]	getRuledCommitmentIdTerms() Gets the commitment Id query terms.
CommitmentQueryInspector[]	getRuledCommitmentTerms() Gets the commitment query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledCommitmentIdTerms

IdTerm[] getRuledCommitmentIdTerms()

Gets the commitment Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledCommitmentTerms

CommitmentQueryInspector[] getRuledCommitmentTerms()

Gets the commitment query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCalendarIdTerms

IdTerm[] getCalendarIdTerms()

Gets the calendar Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCalendarTerms

CalendarQueryInspector[] getCalendarTerms()

Gets the calendar query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerQueryInspectorRecord

CommitmentEnablerQueryInspectorRecord getCommitmentEnablerQueryInspectorRecord(Type commitmentEnablerRecordType)
                                                                               throws OperationFailedException

Gets the commitment enabler query inspector record corresponding to the given CommitmentEnabler record Type.

Parameters:

commitmentEnablerRecordType - a commitment enabler record type

Returns:

the commitment enabler query inspector record

Throws:

NullArgumentException - commitmentEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commitmentEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.