public interface PathSmartMapSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PathQuery
can be retrieved from this session
and mapped to this Map
to create a virtual collection of
Paths.
The paths may be sequenced using the
PathSearchOrder
from this session.
This Map
has a default query that matches any path and
a default search order that specifies no sequencing. The queries may be
examined using a PathQueryInspector.
The query may be
modified by converting the inspector back to a PathQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPathQuery(PathQuery pathQuery)
Applies a path query to this map.
|
void |
applyPathSequencing(PathSearchOrder pathSearchOrder)
Applies a path search order to this map.
|
boolean |
canManageSmartMaps()
Tests if this user can manage smart maps.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
PathQuery |
getPathQuery()
Gets a path query.
|
PathQuery |
getPathQueryFromInspector(PathQueryInspector pathQueryInspector)
Gets a path query from an inspector.
|
PathSearchOrder |
getPathSearchOrder()
Gets a path search order.
|
PathQueryInspector |
inspectPathQuery()
Gets a path query inspector for this map.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartMaps()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart map management is not
authorized, true
otherwisemandatory
- This method must be implemented. PathQuery getPathQuery()
mandatory
- This method must be implemented. PathSearchOrder getPathSearchOrder()
mandatory
- This method must be implemented. void applyPathQuery(PathQuery pathQuery) throws OperationFailedException, PermissionDeniedException
pathQuery
- the path queryNullArgumentException
- pathQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- pathQuery
not of
this servicemandatory
- This method must be implemented. PathQueryInspector inspectPathQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPathSequencing(PathSearchOrder pathSearchOrder) throws OperationFailedException, PermissionDeniedException
pathSearchOrder
- the path search orderNullArgumentException
- pathSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- pathSearchOrder
not of this servicemandatory
- This method must be implemented. PathQuery getPathQueryFromInspector(PathQueryInspector pathQueryInspector)
pathQueryInspector
- a path query inspectorNullArgumentException
- pathQueryInspector
is null
UnsupportedException
- pathQueryInspector
is not of this servicemandatory
- This method must be implemented.