Interface DirectionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DirectionQuerySession, OsidSession, OsidSession

public interface DirectionSearchSession
extends DirectionQuerySession

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

getDirectionsByQuery() is the basic search method and returns a list of Directions. A more advanced search may be performed with getDirectionsBySearch().It accepts a DirectionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDirectionsBySearch() returns a DirectionSearchResults that can be used to access the resulting DirectionList or be used to perform a search within the result set through DirectionSearch.

This session defines views that offer differing behaviors for searching.

• federated cookbook view: searches include directions in cookbooks of which this cookbook is an ancestor in the cookbook hierarchy
• isolated cookbook view: searches are restricted to directions in this cookbooks

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

Method Summary

Modifier and Type	Method	Description
DirectionQuery	getDirectionQueryFromInspector(DirectionQueryInspector directionQueryInspector)	Gets a direction query.
DirectionSearchResults	getDirectionsBySearch(DirectionQuery directionQuery, DirectionSearch directionSearch)	Gets the search results matching the given search query using the given search.
DirectionSearch	getDirectionSearch()	Gets a direction search.
DirectionSearchOrder	getDirectionSearchOrder()	Gets a direction search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DirectionQuerySession

canSearchDirections, getCookbook, getCookbookId, getDirectionQuery, getDirectionsByQuery, useFederatedCookbookView, useIsolatedCookbookView

Modifier and Type	Method	Description
boolean	canSearchDirections()	Tests if this user can perform Direction lookups.
Cookbook	getCookbook()	Gets the Cookbook associated with this session.
Id	getCookbookId()	Gets the Cookbook Id associated with this session.
DirectionQuery	getDirectionQuery()	Gets a direction query.
DirectionList	getDirectionsByQuery(DirectionQuery directionQuery)	Gets a list of Directions matching the given direction query.
void	useFederatedCookbookView()	Federates the view for methods in this session.
void	useIsolatedCookbookView()	Isolates the view for methods in this session.

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

getDirectionSearch

DirectionSearch getDirectionSearch()

Gets a direction search.

Returns:

the direction search

Compliance:

mandatory - This method must be implemented.

getDirectionSearchOrder

DirectionSearchOrder getDirectionSearchOrder()

Gets a direction search order. The DirectionSearchOrder is supplied to a DirectionSearch to specify the ordering of results.

Returns:

the direction search order

Compliance:

mandatory - This method must be implemented.

getDirectionsBySearch

DirectionSearchResults getDirectionsBySearch(DirectionQuery directionQuery,
 DirectionSearch directionSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

directionQuery - the direction query

directionSearch - the direction search

Returns:

the direction search results

Throws:

NullArgumentException - directionQuery or directionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - directionQuery or directionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDirectionQueryFromInspector

DirectionQuery getDirectionQueryFromInspector(DirectionQueryInspector directionQueryInspector)

Gets a direction query. from an inspector. The inspector is available from a DirectionSearchResults.

Parameters:

directionQueryInspector - a direction query inspector

Returns:

the direction query

Throws:

NullArgumentException - directionQueryInspector is null

UnsupportedException - directionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.