public interface ResourceVelocitySession extends OsidSession
This session defines methods to look up resources on paths.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessResourcePaths()
Tests if this user can access the velocities of resources.
|
ResourceVelocityList |
geResourceVelociiesForResource(IdList resourceIds)
Gets the current velocities of the given resources.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
ResourceVelocityList |
getResourceVelocitiesByGenusType(Id pathId)
Gets the current velocities for a resource genus type.
|
ResourceVelocityList |
getResourceVelocitiesInSpatialUnit(SpatialUnit spatialUnit)
Gets the current velocities for given resources in the given spatial
unit.
|
ResourceVelocityList |
getResourceVelocitiesInSpatialUnitByGenusType(SpatialUnit spatialUnit,
Type resourceGenusType)
Gets the current velocities on a given path for a resource genus type.
|
ResourceVelocityList |
getResourceVelocitiesOnPath(Id pathId)
Gets the current resource velocities on a given path.
|
ResourceVelocityList |
getResourceVelocitiesOnPathByGenusType(Id pathId,
Type resourceGenusType)
Gets the current velocities on a given path for a resource genus type.
|
ResourceVelocity |
getResourceVelocity(Id resourceId)
Gets the current velocity of the given resource.
|
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.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenaryResourcePathView()
A complete view of the
Path returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAccessResourcePaths()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer location operations to unauthorized
users. false
if velocity methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeResourcePathView()
mandatory
- This method is must be implemented. void usePlenaryResourcePathView()
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.mandatory
- This method is must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. ResourceVelocity getResourceVelocity(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
NotFoundException
- resourceId
is not on
mapNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceVelocityList geResourceVelociiesForResource(IdList resourceIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceIds
- a resource listNotFoundException
- a resource Id
is not
on mapNullArgumentException
- resourceIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceVelocityList getResourceVelocitiesByGenusType(Id pathId) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
NotFoundException
- pathId
not foundNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceVelocityList getResourceVelocitiesOnPath(Id pathId) throws OperationFailedException, PermissionDeniedException
pathId
- a path Id
NullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceVelocityList getResourceVelocitiesOnPathByGenusType(Id pathId, Type resourceGenusType) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
resourceGenusType
- a resource genus typeNotFoundException
- pathId
not foundNullArgumentException
- pathId
or
resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceVelocityList getResourceVelocitiesInSpatialUnit(SpatialUnit spatialUnit) throws OperationFailedException, PermissionDeniedException
spatialUnit
- a spatial unitNullArgumentException
- spatialUnit
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- spatial unit not supportedmandatory
- This method must be implemented. ResourceVelocityList getResourceVelocitiesInSpatialUnitByGenusType(SpatialUnit spatialUnit, Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
spatialUnit
- a spatial unitresourceGenusType
- a resource genus typeNullArgumentException
- spatialUnit
or
resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- spatial unit not supportedmandatory
- This method must be implemented.