public interface ProcedureSmartCookbookSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ProcedureQuery
can be retrieved from this
session and mapped to this Cookbook
to create a virtual
collection of Procedures.
The awards may be sequenced using
the ProcedureSearchOrder
from this session.
This Cookbook
has a default query that matches any
procedure and a default search order that specifies no sequencing. The
queries may be examined using a ProcedureQueryInspector.
The query may be modified by converting the inspector back to a
ProcedureQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyProcedureQuery(ProcedureQuery procedureQuery)
Applies a procedure query to this cookbook.
|
void |
applyProcedureSequencing(ProcedureSearchOrder procedureSearchOrder)
Applies a procedure search order to this cookbook.
|
boolean |
canManageSmartCookbooks()
Tests if this user can manage smart cook books.
|
Cookbook |
getCookbook()
Gets the
Cookbook associated with this session. |
Id |
getCookbookId()
Gets the
Cookbook Id associated with
this session. |
ProcedureQuery |
getProcedureQuery()
Gets a procedure query.
|
ProcedureQuery |
getProcedureQueryFromInspector(ProcedureQueryInspector procedureQueryInspector)
Gets a procedure query from an inspector.
|
ProcedureSearchOrder |
getProcedureSearchOrder()
Gets a procedure search order.
|
ProcedureQueryInspector |
inspectProcedureQuery()
Gets a procedure 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. Cookbook
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCookbooks()
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. ProcedureQuery getProcedureQuery()
mandatory
- This method must be implemented. ProcedureSearchOrder getProcedureSearchOrder()
mandatory
- This method must be implemented. void applyProcedureQuery(ProcedureQuery procedureQuery) throws OperationFailedException, PermissionDeniedException
procedureQuery
- the procedure queryNullArgumentException
- procedureQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- procedureQuery
not of this servicemandatory
- This method must be implemented. ProcedureQueryInspector inspectProcedureQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyProcedureSequencing(ProcedureSearchOrder procedureSearchOrder) throws OperationFailedException, PermissionDeniedException
procedureSearchOrder
- the procedure search orderNullArgumentException
- procedureSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- procedureSearchOrder
not of this servicemandatory
- This method must be implemented. ProcedureQuery getProcedureQueryFromInspector(ProcedureQueryInspector procedureQueryInspector)
procedureQueryInspector
- a query inspectorNullArgumentException
- procedureQueryInspector
is null
UnsupportedException
- procedureQueryInspector
is not of this servicemandatory
- This method must be implemented.