public interface LocationAdjacencySession extends OsidSession
This session defines methods to traverse through a map.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupLocationAdjacencies()
Tests if this user can query adjacenies of locations A return of true
does not guarantee successful authorization.
|
LocationList |
getAdjacentLocations(Id locationId,
long hops)
Gets a list of adjacent locations for the given location.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
boolean |
isAdjacent(Id locationId,
Id anotherLocationId)
Tests if two locations of the same type are adjacent.
|
void |
useComparativeLocationView()
The returns from the traversal 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 |
usePlenaryLocationView()
A complete view of the method 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 canLookupLocationAdjacencies()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if location adjacency methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeLocationView()
mandatory
- This method is must be implemented. void usePlenaryLocationView()
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. LocationList getAdjacentLocations(Id locationId, long hops) throws NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the given location Id
hops
- the number of hops to include. 0 returns an empty list. 1
returns the immediate adjacent locations.NotFoundException
- locationId
is not
foundNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean isAdjacent(Id locationId, Id anotherLocationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
locationId
- the given location Id
anotherLocationId
- the given location Id
true
of the locations are adjacent,
false
otherwiseNotFoundException
- locationId
or
anotherLocationId
is not foundNullArgumentException
- locationId
or
anotherLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.