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.

Like all OsidQueryInspectors, SignalEnablerQueryInspector is stateful and must not be accessed by multiple processing threads.

  • Method Details

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