Interface SignalEnablerLookupSession

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

This session provides methods for retrieving SignalEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated map view: All signal enabler methods in this session operate, retrieve and pertain to signal enabler defined explicitly in the current map. Using an isolated view is useful for managing SignalEnablers with the SignalEnablerAdminSession .
  • federated map view: All signal enabler 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.
  • active signal enabler view: All signal enabler lookup methods return active signal enablers.
  • any status signal enabler view: Signal enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking the methods in this session.

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

    • canLookupSignalEnablers

      boolean canLookupSignalEnablers()
      Tests if this user can perform SignalEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeSignalEnablerView

      void useComparativeSignalEnablerView()
      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.

    • usePlenarySignalEnablerView

      void usePlenarySignalEnablerView()
      A complete view of the SignalEnabler 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 map 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 maps only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveSignalEnablerView

      void useActiveSignalEnablerView()
      Only active signal enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusSignalEnablerView

      void useAnyStatusSignalEnablerView()
      All active and inactive signal enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getSignalEnabler

      SignalEnabler getSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the SignalEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SignalEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a SignalEnabler and retained for compatibility. In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      signalEnablerId - Id of the SignalEnabler
      Returns:
      the signal enabler
      Throws:
      NotFoundException - signalEnablerId not found
      NullArgumentException - signalEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getSignalEnablersByIds

      SignalEnablerList getSignalEnablersByIds(IdList signalEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a SignalEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the signal enabler specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SignalEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      signalEnablerIds - the list of Ids to retrieve
      Returns:
      the returned SignalEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - signalEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersByGenusType

      SignalEnablerList getSignalEnablersByGenusType(Type signalEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a SignalEnablerList corresponding to the given signal enabler genus Type which does not include signal enabler of genus types derived from the specified Type . In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session. In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      signalEnablerGenusType - a signal enabler genus type
      Returns:
      the returned SignalEnabler list
      Throws:
      NullArgumentException - signalEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersByParentGenusType

      SignalEnablerList getSignalEnablersByParentGenusType(Type signalEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a SignalEnablerList corresponding to the given signal enabler genus Type and include any additional signal enabler with genus types derived from the specified Type . In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session. In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      signalEnablerGenusType - a signal enabler genus type
      Returns:
      the returned SignalEnabler list
      Throws:
      NullArgumentException - signalEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersByRecordType

      SignalEnablerList getSignalEnablersByRecordType(Type signalEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a SignalEnablerList containing the given signal enabler record Type . In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session. In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      signalEnablerRecordType - a signal enabler record type
      Returns:
      the returned SignalEnabler list
      Throws:
      NullArgumentException - signalEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersOnDate

      SignalEnablerList getSignalEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a SignalEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known signal enablers or an error results. Otherwise, the returned list may contain only those signal enablers that are accessible through this session. In active mode, signal enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned SignalEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersOnDateWithAgent

      SignalEnablerList getSignalEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a SignalEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known signal enablers or an error results. Otherwise, the returned list may contain only those signal enablers that are accessible through this session. In active mode, signal enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive signal enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned SignalEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablers

      SignalEnablerList getSignalEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all SignalEnablers . In plenary mode, the returned list contains all known signal enabler or an error results. Otherwise, the returned list may contain only those signal enabler that are accessible through this session. In active mode, signal enablers are returned that are currently active. In any status mode, active and inactive signal enablers are returned.
      Returns:
      the returned SignalEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.