Interface SignalEnablerRuleLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface SignalEnablerRuleLookupSession extends OsidSession

This session provides methods to retrieve SignalEnabler to Signal mappings. A Signal with multiple SignalEnablers means any positive rule evaluation across the enablers result in an enabled Signal .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated map view: All methods in this session operate, retrieve and pertain signal enabler defined explicitly in the current map
  • federated map view: All methods in this session operate, retrieve and pertain to all signal enabler defined in this map and any other signal enabler implicitly available in this map through map inheritence.

  • Method Details

    • getMapId

      Id getMapId()
      Gets the Map Id associated with this session.
      Returns:
      the Map Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getMap

      Map getMap() throws OperationFailedException, PermissionDeniedException
      Gets the Map associated with this session.
      Returns:
      the map
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupSignalEnablerRules

      boolean canLookupSignalEnablerRules()
      Tests if this user can perform lookups of signal enabler/signal mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeSignalEnablerRuleView

      void useComparativeSignalEnablerRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenarySignalEnablerRuleView

      void usePlenarySignalEnablerRuleView()
      A complete view of the SignalEnabler and Signal returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedMapView

      void useFederatedMapView()
      Federates the view for methods in this session. A federated view will include signal enabler in maps which are children of this map in the map hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedMapView

      void useIsolatedMapView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this map only.
      Compliance:
      mandatory - This method is must be implemented.

    • getSignalEnablerIdsForSignal

      IdList getSignalEnablerIdsForSignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the SignalEnabler Id associated with a Signal .
      Parameters:
      signalId - Id of the Signal
      Returns:
      the signal enabler Ids
      Throws:
      NotFoundException - signalId is not found
      NullArgumentException - signalId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersForSignal

      SignalEnablerList getSignalEnablersForSignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the SignalEnabler associated with a Signal .
      Parameters:
      signalId - Id of the Signal
      Returns:
      the signal enablers
      Throws:
      NotFoundException - signalId is not found
      NullArgumentException - signalId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalIdsForSignalEnabler

      IdList getSignalIdsForSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Signal Ids mapped to a SignalEnabler .
      Parameters:
      signalEnablerId - Id of a SignalEnabler
      Returns:
      list of signal Ids
      Throws:
      NotFoundException - signalEnablerId is not found
      NullArgumentException - signalEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalsForSignalEnabler

      SignalList getSignalsForSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Signals mapped to a SignalEnabler .
      Parameters:
      signalEnablerId - Id of a SignalEnabler
      Returns:
      list of signals
      Throws:
      NotFoundException - signalEnablerId is not found
      NullArgumentException - signalEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.