Interface LocationMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LocationMapSession
extends OsidSession

This session provides methods to retrieve Location to Map locations. A Location may appear in multiple Maps . 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	canLookupLocationMapLocations()	Tests if this user can perform lookups of location/map locations.
IdList	getLocationIdsByMap(Id mapId)	Gets the list of Location Ids associated with a Map .
IdList	getLocationIdsByMaps(IdList mapIds)	Gets the list of Location Ids corresponding to a list of Maps .
LocationList	getLocationsByMap(Id mapId)	Gets the list of Locations associated with a Map .
LocationList	getLocationsByMaps(IdList mapIds)	Gets the list of Locations corresponding to a list of Maps .
IdList	getMapIdsByLocation(Id locationId)	Gets the Map Ids mapped to a Location .
MapList	getMapsByLocation(Id locationId)	Gets the Maps mapped to a Location .
void	useComparativeLocationMapView()	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	usePlenaryLocationMapView()	A complete view of the Location 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

canLookupLocationMapLocations

boolean canLookupLocationMapLocations()

Tests if this user can perform lookups of location/map locations. 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 locations is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeLocationMapView

void useComparativeLocationMapView()

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.

usePlenaryLocationMapView

void usePlenaryLocationMapView()

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

getLocationIdsByMap

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

Gets the list of Location Ids associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

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

getLocationsByMap

LocationList getLocationsByMap(Id mapId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Locations associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related locations

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.

getLocationIdsByMaps

IdList getLocationIdsByMaps(IdList mapIds)
                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mapIds - list of map Ids

Returns:

list of location Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLocationsByMaps

LocationList getLocationsByMaps(IdList mapIds)
                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mapIds - list of map Ids

Returns:

list of locations

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsByLocation

IdList getMapIdsByLocation(Id locationId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to a Location .

Parameters:

locationId - Id of a Location

Returns:

list of maps

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByLocation

MapList getMapsByLocation(Id locationId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to a Location .

Parameters:

locationId - Id of a Location

Returns:

list of maps

Throws:

NotFoundException - locationId is not found

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.