org.osid.recipe

Interface DirectionSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DirectionQuerySession, 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 cook book view: searches include directions in cook books of which this cook book is an ancestor in the cook book hierarchy
• isolated cook book view: searches are restricted to directions in this cook books

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

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.recipe.DirectionQuerySession

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

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

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.