Interface BlockSmartOublietteSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface BlockSmartOublietteSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A BlockQuery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of Blocks . The blocks may be sequenced using the BlockSearchOrder from this session.

This Oubliette has a default query that matches any block and a default search order that specifies no sequencing. The queries may be examined using a BlockQueryInspector . The query may be modified by converting the inspector back to a BlockQuery .

  • Method Details

    • getOublietteId

      Id getOublietteId()
      Gets the Oubliette Id associated with this session.
      Returns:
      the Oubliette Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getOubliette

      Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
      Gets the Oubliette associated with this session.
      Returns:
      the oubliette
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartOubliettes

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

    • getBlockQuery

      BlockQuery getBlockQuery()
      Gets a block query.
      Returns:
      the block query
      Compliance:
      mandatory - This method must be implemented.

    • getBlockSearchOrder

      BlockSearchOrder getBlockSearchOrder()
      Gets a block search order.
      Returns:
      the block search order
      Compliance:
      mandatory - This method must be implemented.

    • applyBlockQuery

      void applyBlockQuery(BlockQuery blockQuery) throws OperationFailedException, PermissionDeniedException
      Applies a block query to this oubliette.
      Parameters:
      blockQuery - the block query
      Throws:
      NullArgumentException - blockQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - blockQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectBlockQuery

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

    • applyBlockSequencing

      void applyBlockSequencing(BlockSearchOrder blockSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a block search order to this oubliette.
      Parameters:
      blockSearchOrder - the block search order
      Throws:
      NullArgumentException - blockSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - blockSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBlockQueryFromInspector

      BlockQuery getBlockQueryFromInspector(BlockQueryInspector blockQueryInspector)
      Gets a block query from an inspector.
      Parameters:
      blockQueryInspector - a block query inspector
      Returns:
      the block query
      Throws:
      NullArgumentException - blockQueryInspector is null
      UnsupportedException - blockQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.