Interface IntersectionMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IntersectionMapSession
extends OsidSession

This session provides methods to retrieve Intersection to Map mappings. An Intersection 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	canLookupIntersectionMapLocations()	Tests if this user can perform lookups of intersection/map mappings.
IdList	getIntersectionIdsByMap(Id mapId)	Gets the list of Intersection Ids associated with a Map .
IdList	getIntersectionIdsByMaps(IdList mapIds)	Gets the list of Intersection Ids corresponding to a list of Maps .
IntersectionList	getIntersectionsByMap(Id mapId)	Gets the list of Intersections associated with a Map .
IntersectionList	getIntersectionsByMaps(IdList mapIds)	Gets the list of Intersection corresponding to a list of Maps .
IdList	getMapIdsByIntersection(Id intersectionId)	Gets the Map Ids mapped to an Intersection .
MapList	getMapsByIntersection(Id intersectionId)	Gets the Maps mapped to an Intersection .
void	useComparativeIntersectionMapView()	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	usePlenaryIntersectionMapView()	A complete view of the Intersection 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

canLookupIntersectionMapLocations

boolean canLookupIntersectionMapLocations()

Tests if this user can perform lookups of intersection/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.

useComparativeIntersectionMapView

void useComparativeIntersectionMapView()

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.

usePlenaryIntersectionMapView

void usePlenaryIntersectionMapView()

A complete view of the Intersection 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.

getIntersectionIdsByMap

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

Gets the list of Intersection Ids associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related intersection 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.

getIntersectionsByMap

IntersectionList getIntersectionsByMap(Id mapId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Intersections associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related intersections

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.

getIntersectionIdsByMaps

IdList getIntersectionIdsByMaps(IdList mapIds)
                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mapIds - list of map Ids

Returns:

list of intersection Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIntersectionsByMaps

IntersectionList getIntersectionsByMaps(IdList mapIds)
                                 throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mapIds - list of map Ids

Returns:

list of intersections

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsByIntersection

IdList getMapIdsByIntersection(Id intersectionId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to an Intersection .

Parameters:

intersectionId - Id of an Intersection

Returns:

list of maps

Throws:

NotFoundException - intersectionId is not found

NullArgumentException - intersectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByIntersection

MapList getMapsByIntersection(Id intersectionId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to an Intersection .

Parameters:

intersectionId - Id of an Intersection

Returns:

list of maps

Throws:

NotFoundException - intersectionId is not found

NullArgumentException - intersectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.