Interface DirectionSmartCookbookSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
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.

Like all OsidSessions, DirectionSmartCookbookSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartOubiliettes

      boolean canManageSmartOubiliettes()
      Tests if this user can manage smart oubiliettes. 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 cookbook management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionQuery

      DirectionQuery getDirectionQuery()
      Gets a direction query.
      Returns:
      the direction query
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionSearchOrder

      DirectionSearchOrder getDirectionSearchOrder()
      Gets a direction search order.
      Returns:
      the direction search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDirectionQuery

      void applyDirectionQuery(DirectionQuery directionQuery) throws OperationFailedException, PermissionDeniedException
      Applies a direction query to this cookbook.
      Parameters:
      directionQuery - the direction query
      Throws:
      NullArgumentException - directionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - directionQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectDirectionQuery

      DirectionQueryInspector inspectDirectionQuery() throws OperationFailedException, PermissionDeniedException
      Gets a direction query inspector for this cookbook.
      Returns:
      the direction query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyDirectionSequencing

      void applyDirectionSequencing(DirectionSearchOrder directionSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a direction search order to this cookbook.
      Parameters:
      directionSearchOrder - the direction search order
      Throws:
      NullArgumentException - directionSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - directionSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionQueryFromInspector

      DirectionQuery getDirectionQueryFromInspector(DirectionQueryInspector directionQueryInspector)
      Gets a direction query from an inspector.
      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.