org.osid.mapping

Interface MapQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

MapSearchSession

public interface MapQuerySession
extends OsidSession

This session provides methods for searching among Map objects. The search query is constructed using the MapQuery.

Maps may have a query record indicated by their respective record types. The query record is accessed via the MapQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchMaps() Tests if this user can perform Map searches.
MapQuery	getMapQuery() Gets a map query.
MapList	getMapsByQuery(MapQuery mapQuery) Gets a list of Maps matching the given map query.

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

canSearchMaps

boolean canSearchMaps()

Tests if this user can perform Map searches. 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 not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getMapQuery

MapQuery getMapQuery()

Gets a map query.

Returns:

the map query

Compliance:

mandatory - This method must be implemented.

getMapsByQuery

MapList getMapsByQuery(MapQuery mapQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Gets a list of Maps matching the given map query.

Parameters:

mapQuery - the map query

Returns:

the returned MapList

Throws:

NullArgumentException - mapQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - mapQuery is not of this service

Compliance:

mandatory - This method must be implemented.