Interface DeviceEnablerLookupSession

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

This session provides methods for retrieving DeviceEnablers .

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 system view: All device enabler methods in this session operate, retrieve and pertain to device enablers defined explicitly in the current system. Using an isolated view is useful for managing DeviceEnablers with the DeviceEnablerAdminSession .
  • federated system view: All device enabler methods in this session operate, retrieve and pertain to all device enablers defined in this system and any other device enablers implicitly available in this system through system inheritence.
  • activee device enabler view: All device enabler lookup methods return active device enablers.
  • any status device enabler view: device 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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canLookupDeviceEnablers

      boolean canLookupDeviceEnablers()
      Tests if this user can perform DeviceEnablers 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.

    • useComparativeDeviceEnablerView

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

    • usePlenaryDeviceEnablerView

      void usePlenaryDeviceEnablerView()
      A complete view of the DeviceEnabler 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.

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include device enablers in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

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

    • useActiveDeviceEnablerView

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

    • useAnyStatusDeviceEnablerView

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

    • getDeviceEnabler

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

    • getDeviceEnablersByIds

      DeviceEnablerList getDeviceEnablersByIds(IdList deviceEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a DeviceEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the device enablers 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 DeviceEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, device enablers are returned that are currently active. In any status mode, active and inactive device enablers are returned.
      Parameters:
      deviceEnablerIds - the list of Ids to retrieve
      Returns:
      the returned DeviceEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - deviceEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDeviceEnablersByGenusType

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

    • getDeviceEnablersByParentGenusType

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

    • getDeviceEnablersByRecordType

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

    • getDeviceEnablersOnDate

      DeviceEnablerList getDeviceEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a DeviceEnablerList that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known device enablers or an error results. Otherwise, the returned list may contain only those device enablers that are accessible through this session. In active mode, device enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive device enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned DeviceEnabler 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.

    • getDeviceEnablersOnDateWithAgent

      DeviceEnablerList getDeviceEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a DeviceEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known device enablers or an error results. Otherwise, the returned list may contain only those device enablers that are accessible through this session. In active mode, device enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive device enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned DeviceEnabler 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.

    • getDeviceEnablers

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