Interface ObstacleEnablerLookupSession

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

This session provides methods for retrieving ObstacleEnablers .

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 obstacle enabler methods in this session operate, retrieve and pertain to obstacle enabler defined explicitly in the current map. Using an isolated view is useful for managing ObstacleEnablers with the ObstacleEnablerAdminSession .
  • federated map view: All obstacle enabler methods in this session operate, retrieve and pertain to all obstacle enabler defined in this map and any other obstacle enabler implicitly available in this map through map inheritence.
  • active obstacle enabler view: All obstacle enabler lookup methods return active obstacle enablers.
  • any status obstacle enabler view: Obstacle 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.

    • canLookupObstacleEnablers

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

    • useComparativeObstacleEnablerView

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

    • usePlenaryObstacleEnablerView

      void usePlenaryObstacleEnablerView()
      A complete view of the ObstacleEnabler 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 obstacle 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.

    • useActiveObstacleEnablerView

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

    • useAnyStatusObstacleEnablerView

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

    • getObstacleEnabler

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

    • getObstacleEnablersByIds

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

    • getObstacleEnablersByGenusType

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

    • getObstacleEnablersByParentGenusType

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

    • getObstacleEnablersByRecordType

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

    • getObstacleEnablersOnDate

      ObstacleEnablerList getObstacleEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleEnablerList 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 obstacle enablers or an error results. Otherwise, the returned list may contain only those obstacle enablers that are accessible through this session. In active mode, obstacle enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive obstacle enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned ObstacleEnabler 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.

    • getObstacleEnablersOnDateWithAgent

      ObstacleEnablerList getObstacleEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an ObstacleEnablerList 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 obstacle enablers or an error results. Otherwise, the returned list may contain only those obstacle enablers that are accessible through this session. In active mode, obstacle enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive obstacle enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned ObstacleEnabler 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.

    • getObstacleEnablers

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