org.osid.mapping

Interface MapLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface MapLookupSession
extends OsidSession

This session provides methods for retrieving Map objects. The Map represents a collection of locations.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Maps it can access, without breaking execution. However, an assessment may only be useful if all Maps referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupMaps() Tests if this user can perform Map lookups.
Map	getMap(Id mapId) Gets the Map specified by its Id.
MapList	getMaps() Gets all Maps.
MapList	getMapsByGenusType(Type mapGenusType) Gets a MapList corresponding to the given map genus Type which does not include maps of types derived from the specified Type.
MapList	getMapsByIds(IdList mapIds) Gets a MapList corresponding to the given IdList.
MapList	getMapsByParentGenusType(Type mapGenusType) Gets a MapList corresponding to the given map genus Type and include any additional maps with genus types derived from the specified Type.
MapList	getMapsByProvider(Id resourceId) Gets a MapList for the given provider.
MapList	getMapsByRecordType(Type mapRecordType) Gets a MapList containing the given map record Type.
void	useComparativeMapView() 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	usePlenaryMapView() A complete view of the Map returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupMaps

boolean canLookupMaps()

Tests if this user can perform Map lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeMapView

void useComparativeMapView()

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.

usePlenaryMapView

void usePlenaryMapView()

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

getMap

Map getMap(Id mapId)
           throws NotFoundException,
                  OperationFailedException,
                  PermissionDeniedException

Gets the Map specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Map may have a different Id than requested, such as the case where a duplicate Id was assigned to a Map and retained for compatibility.

Parameters:

mapId - Id of the Map

Returns:

the map

Throws:

NotFoundException - mapId not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getMapsByIds

MapList getMapsByIds(IdList mapIds)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets a MapList corresponding to the given IdList. In plenary mode, the returned list contains all of the maps specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Maps may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

mapIds - the list of Ids to retrieve

Returns:

the returned Map list

Throws:

NotFoundException - an Id was not found

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByGenusType

MapList getMapsByGenusType(Type mapGenusType)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a MapList corresponding to the given map genus Type which does not include maps of types derived from the specified Type. In plenary mode, the returned list contains all known maps or an error results. Otherwise, the returned list may contain only those maps that are accessible through this session.

Parameters:

mapGenusType - a map genus type

Returns:

the returned Map list

Throws:

NullArgumentException - mapGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByParentGenusType

MapList getMapsByParentGenusType(Type mapGenusType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a MapList corresponding to the given map genus Type and include any additional maps with genus types derived from the specified Type. In plenary mode, the returned list contains all known maps or an error results. Otherwise, the returned list may contain only those maps that are accessible through this session.

Parameters:

mapGenusType - a map genus type

Returns:

the returned Map list

Throws:

NullArgumentException - mapGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByRecordType

MapList getMapsByRecordType(Type mapRecordType)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets a MapList containing the given map record Type. In plenary mode, the returned list contains all known maps or an error results. Otherwise, the returned list may contain only those maps that are accessible through this session.

Parameters:

mapRecordType - a map record type

Returns:

the returned Map list

Throws:

NullArgumentException - mapRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByProvider

MapList getMapsByProvider(Id resourceId)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets a MapList for the given provider. In plenary mode, the returned list contains all known maps or an error results. Otherwise, the returned list may contain only those maps that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Map list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMaps

MapList getMaps()
                throws OperationFailedException,
                       PermissionDeniedException

Gets all Maps. In plenary mode, the returned list contains all known maps or an error results. Otherwise, the returned list may contain only those maps that are accessible through this session.

Returns:

a list of Maps

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.