Interface ObstacleMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObstacleMapSession
extends OsidSession

This session provides methods to retrieve Obstacle to Map mappings. An Obstacle may appear in multiple Map objects. Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupObstacleMapObstacles()	Tests if this user can perform lookups of obstacle/map mappings.
IdList	getMapIdsByObstacle(Id obstacleId)	Gets the Map Ids mapped an an Obstacle .
MapList	getMapsByObstacle(Id obstacleId)	Gets the Maps mapped to an Obstacle .
IdList	getObstacleIdsByMap(Id mapId)	Gets the list of Obstacle Ids associated with a Map .
IdList	getObstacleIdsByMaps(IdList mapIds)	Gets the list of Obstacle Ids corresponding to a list of Maps .
ObstacleList	getObstaclesByMap(Id mapId)	Gets the list of Obstacles associated with a Map .
ObstacleList	getObstaclesByMaps(IdList mapIds)	Gets the list of Obstacles corresponding to a list of Maps .
void	useComparativeObstacleMapView()	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	usePlenaryObstacleMapView()	A complete view of the Obstacle and Map returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupObstacleMapObstacles

boolean canLookupObstacleMapObstacles()

Tests if this user can perform lookups of obstacle/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeObstacleMapView

void useComparativeObstacleMapView()

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.

usePlenaryObstacleMapView

void usePlenaryObstacleMapView()

A complete view of the Obstacle and Map 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.

getObstacleIdsByMap

IdList getObstacleIdsByMap(Id mapId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Obstacle Ids associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related obstacle Ids

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObstaclesByMap

ObstacleList getObstaclesByMap(Id mapId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Obstacles associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related obstacle

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObstacleIdsByMaps

IdList getObstacleIdsByMaps(IdList mapIds)
                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Obstacle Ids corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of obstacle Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObstaclesByMaps

ObstacleList getObstaclesByMaps(IdList mapIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Obstacles corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of obstacle

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsByObstacle

IdList getMapIdsByObstacle(Id obstacleId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped an an Obstacle .

Parameters:

obstacleId - Id of an Obstacle

Returns:

list of maps

Throws:

NotFoundException - obstacleId is not found

NullArgumentException - obstacleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByObstacle

MapList getMapsByObstacle(Id obstacleId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to an Obstacle .

Parameters:

obstacleId - Id of an Obstacle

Returns:

list of maps

Throws:

NotFoundException - obstacleId is not found

NullArgumentException - obstacleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.