org.osid.mapping.path.rules

Interface SignalEnablerQueryInspector

All Superinterfaces:

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

public interface SignalEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query interface for examining signal enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getMapIdTerms() Gets the map Id query terms.
MapQueryInspector[]	getMapTerms() Gets the map query terms.
IdTerm[]	getRuledSignalIdTerms() Gets the signal Id query terms.
SignalQueryInspector[]	getRuledSignalTerms() Gets the signal query terms.
SignalEnablerQueryInspectorRecord	getSignalEnablerQueryInspectorRecord(Type signalEnablerRecordType) Gets the signal enabler query inspector record corresponding to the given SignalEnabler record Type.

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

getRuledSignalIdTerms

IdTerm[] getRuledSignalIdTerms()

Gets the signal Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledSignalTerms

SignalQueryInspector[] getRuledSignalTerms()

Gets the signal query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMapIdTerms

IdTerm[] getMapIdTerms()

Gets the map Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMapTerms

MapQueryInspector[] getMapTerms()

Gets the map query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSignalEnablerQueryInspectorRecord

SignalEnablerQueryInspectorRecord getSignalEnablerQueryInspectorRecord(Type signalEnablerRecordType)
                                                                       throws OperationFailedException

Gets the signal enabler query inspector record corresponding to the given SignalEnabler record Type.

Parameters:

signalEnablerRecordType - a signal enabler record type

Returns:

the signal enabler query inspector record

Throws:

NullArgumentException - signalEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.