Interface PathSmartMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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 .

Method Summary

Modifier and Type	Method	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.

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

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
    throws OperationFailedException,
PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartMaps

boolean canManageSmartMaps()

Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart map management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPathQuery

PathQuery getPathQuery()

Gets a path query.

Returns:

the path query

Compliance:

mandatory - This method must be implemented.

getPathSearchOrder

PathSearchOrder getPathSearchOrder()

Gets a path search order.

Returns:

the path search order

Compliance:

mandatory - This method must be implemented.

applyPathQuery

void applyPathQuery(PathQuery pathQuery)
             throws OperationFailedException,
PermissionDeniedException

Applies a path query to this map.

Parameters:

pathQuery - the path query

Throws:

NullArgumentException - pathQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - pathQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPathQuery

PathQueryInspector inspectPathQuery()
                             throws OperationFailedException,
PermissionDeniedException

Gets a path query inspector for this map.

Returns:

the path query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPathSequencing

void applyPathSequencing(PathSearchOrder pathSearchOrder)
                  throws OperationFailedException,
PermissionDeniedException

Applies a path search order to this map.

Parameters:

pathSearchOrder - the path search order

Throws:

NullArgumentException - pathSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - pathSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPathQueryFromInspector

PathQuery getPathQueryFromInspector(PathQueryInspector pathQueryInspector)

Gets a path query from an inspector.

Parameters:

pathQueryInspector - a path query inspector

Returns:

the path query

Throws:

NullArgumentException - pathQueryInspector is null

UnsupportedException - pathQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.