public interface DirectionQuerySession extends OsidSession
This session provides methods for searching among Direction
objects. The search query is constructed using the
DirectionQuery.
This session defines views that offer differing behaviors for searching.
Directions may have a query record indicated by their respective
record types. The query record is accessed via the DirectionQuery.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCookbookId()
Cookbook
Id
associated with
this session. Cookbook Id
associated with this sessionmandatory
- This method must be implemented. Cookbook getCookbook() throws OperationFailedException, PermissionDeniedException
Cookbook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchDirections()
Direction
lookups. 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. void useFederatedCookbookView()
mandatory
- This method is must be implemented. void useIsolatedCookbookView()
mandatory
- This method is must be implemented. DirectionQuery getDirectionQuery()
mandatory
- This method must be implemented. DirectionList getDirectionsByQuery(DirectionQuery directionQuery) throws OperationFailedException, PermissionDeniedException
Directions
matching the given direction
query.directionQuery
- the direction query DirectionList
NullArgumentException
- directionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- directionQuery
is
not of this servicemandatory
- This method must be implemented.