public interface DirectionSmartCookbookSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A DirectionQuery
can be retrieved from this
session and assigned to this Cookbook
to create a virtual
collection of Directions.
The directions may be sequenced
using the DirectionSearchOrder
from this session.
This Cookbook
has a default query that matches any
direction and a default search order that specifies no sequencing. The
queries may be examined using a DirectionQueryInspector.
The query may be modified by converting the inspector back to a
DirectionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDirectionQuery(DirectionQuery directionQuery)
Applies a direction query to this cookbook.
|
void |
applyDirectionSequencing(DirectionSearchOrder directionSearchOrder)
Applies a direction search order to this cookbook.
|
boolean |
canManageSmartOubiliettes()
Tests if this user can manage smart oubiliettes.
|
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.
|
DirectionQuery |
getDirectionQueryFromInspector(DirectionQueryInspector directionQueryInspector)
Gets a direction query from an inspector.
|
DirectionSearchOrder |
getDirectionSearchOrder()
Gets a direction search order.
|
DirectionQueryInspector |
inspecDirectionQuery()
Gets a direction query inspector for this cookbook.
|
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 canManageSmartOubiliettes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart cook book management is not
authorized, true
otherwisemandatory
- This method must be implemented. DirectionQuery getDirectionQuery()
mandatory
- This method must be implemented. DirectionSearchOrder getDirectionSearchOrder()
mandatory
- This method must be implemented. void applyDirectionQuery(DirectionQuery directionQuery) throws OperationFailedException, PermissionDeniedException
directionQuery
- the direction queryNullArgumentException
- directionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- directionQuery
not of this servicemandatory
- This method must be implemented. DirectionQueryInspector inspecDirectionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDirectionSequencing(DirectionSearchOrder directionSearchOrder) throws OperationFailedException, PermissionDeniedException
directionSearchOrder
- the direction search orderNullArgumentException
- directionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- directionSearchOrder
not of this servicemandatory
- This method must be implemented. DirectionQuery getDirectionQueryFromInspector(DirectionQueryInspector directionQueryInspector)
directionQueryInspector
- a direction query inspectorNullArgumentException
- directionQueryInspector
is null
UnsupportedException
- directionQueryInspector
is not of this servicemandatory
- This method must be implemented.