Interface ResourceVelocitySession

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

This session defines methods to look up resources on paths.

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

    • canAccessResourcePaths

      boolean canAccessResourcePaths()
      Tests if this user can access the velocities of resources. 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 not offer location operations to unauthorized users.
      Returns:
      false if velocity methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeResourcePathView

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

    • usePlenaryResourcePathView

      void usePlenaryResourcePathView()
      A complete view of the Path 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 paths 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 retrievals to this map only.
      Compliance:
      mandatory - This method is must be implemented.

    • getResourceVelocity

      ResourceVelocity getResourceVelocity(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the current velocity of the given resource.
      Parameters:
      resourceId - a resource Id
      Returns:
      the current velocity
      Throws:
      NotFoundException - resourceId is not on map
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • geResourceVelociiesForResource

      ResourceVelocityList geResourceVelociiesForResource(IdList resourceIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the current velocities of the given resources. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
      Parameters:
      resourceIds - a resource list
      Returns:
      the current velocities
      Throws:
      NotFoundException - a resource Id is not on map
      NullArgumentException - resourceIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getResourceVelocitiesByGenusType

      ResourceVelocityList getResourceVelocitiesByGenusType(Id pathId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the current velocities for a resource genus type. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
      Parameters:
      pathId - a path Id
      Returns:
      the resource velocities
      Throws:
      NotFoundException - pathId not found
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getResourceVelocitiesOnPath

      ResourceVelocityList getResourceVelocitiesOnPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Gets the current resource velocities on a given path. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
      Parameters:
      pathId - a path Id
      Returns:
      the resource velocities
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getResourceVelocitiesOnPathByGenusType

      ResourceVelocityList getResourceVelocitiesOnPathByGenusType(Id pathId, Type resourceGenusType) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the current velocities on a given path for a resource genus type. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
      Parameters:
      pathId - a path Id
      resourceGenusType - a resource genus type
      Returns:
      the resource velocities
      Throws:
      NotFoundException - pathId not found
      NullArgumentException - pathId or resourceGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getResourceVelocitiesInSpatialUnit

      ResourceVelocityList getResourceVelocitiesInSpatialUnit(SpatialUnit spatialUnit) throws OperationFailedException, PermissionDeniedException
      Gets the current velocities for given resources in the given spatial unit.
      Parameters:
      spatialUnit - a spatial unit
      Returns:
      the current velocities
      Throws:
      NullArgumentException - spatialUnit is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - spatial unit not supported
      Compliance:
      mandatory - This method must be implemented.

    • getResourceVelocitiesInSpatialUnitByGenusType

      ResourceVelocityList getResourceVelocitiesInSpatialUnitByGenusType(SpatialUnit spatialUnit, Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
      Gets the current velocities on a given path for a resource genus type. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
      Parameters:
      spatialUnit - a spatial unit
      resourceGenusType - a resource genus type
      Returns:
      the resource velocities
      Throws:
      NullArgumentException - spatialUnit or resourceGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - spatial unit not supported
      Compliance:
      mandatory - This method must be implemented.