org.osid.recipe

Interface ProcedureSmartCookbookSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

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

getCookbookId

Id getCookbookId()

Gets the Cookbook Id associated with this session.

Returns:

the Cookbook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCookbook

Cookbook getCookbook()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Cookbook associated with this session.

Returns:

the Cookbook associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartCookbooks

boolean canManageSmartCookbooks()

Tests if this user can manage smart cook books. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart cook book management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getProcedureQuery

ProcedureQuery getProcedureQuery()

Gets a procedure query.

Returns:

the procedure query

Compliance:

mandatory - This method must be implemented.

getProcedureSearchOrder

ProcedureSearchOrder getProcedureSearchOrder()

Gets a procedure search order.

Returns:

the procedure search order

Compliance:

mandatory - This method must be implemented.

applyProcedureQuery

void applyProcedureQuery(ProcedureQuery procedureQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a procedure query to this cookbook.

Parameters:

procedureQuery - the procedure query

Throws:

NullArgumentException - procedureQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - procedureQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProcedureQuery

ProcedureQueryInspector inspectProcedureQuery()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a procedure query inspector for this cookbook.

Returns:

the procedure query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProcedureSequencing

void applyProcedureSequencing(ProcedureSearchOrder procedureSearchOrder)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a procedure search order to this cookbook.

Parameters:

procedureSearchOrder - the procedure search order

Throws:

NullArgumentException - procedureSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - procedureSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProcedureQueryFromInspector

ProcedureQuery getProcedureQueryFromInspector(ProcedureQueryInspector procedureQueryInspector)

Gets a procedure query from an inspector.

Parameters:

procedureQueryInspector - a query inspector

Returns:

the procedure query

Throws:

NullArgumentException - procedureQueryInspector is null

UnsupportedException - procedureQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.