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.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchMaps()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. MapQuery getMapQuery()
mandatory
- This method must be implemented. MapList getMapsByQuery(MapQuery mapQuery) throws OperationFailedException, PermissionDeniedException
Maps
matching the given map query.mapQuery
- the map query MapList
NullArgumentException
- mapQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- mapQuery
is not
of this servicemandatory
- This method must be implemented.