Interface ModelSmartWarehouseSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ModelQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Models. The models may be sequenced using the ModelSearchOrder from this session.

This Warehouse has a default query that matches any model and a default search order that specifies no sequencing. The queries may be examined using a ModelQueryInspector. The query may be modified by converting the inspector back to a ModelQuery.

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

  • Method Details

    • getWarehouseId

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

    • getWarehouse

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

    • canManageSmartWarehouses

      boolean canManageSmartWarehouses()
      Tests if this user can manage smart warehouses. A return of true does not guarantee successful assessment. 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 warehouse management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getModelQuery

      ModelQuery getModelQuery()
      Gets a model query.
      Returns:
      the model query
      Compliance:
      mandatory - This method must be implemented.

    • getModelSearchOrder

      ModelSearchOrder getModelSearchOrder()
      Gets a model search order.
      Returns:
      the model search order
      Compliance:
      mandatory - This method must be implemented.

    • applyModelQuery

      void applyModelQuery(ModelQuery modelQuery) throws OperationFailedException, PermissionDeniedException
      Applies a model query to this warehouse.
      Parameters:
      modelQuery - the model query
      Throws:
      NullArgumentException - modelQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - modelQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectModelQuery

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

    • applyModelSequencing

      void applyModelSequencing(ModelSearchOrder modelSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a model search order to this warehouse.
      Parameters:
      modelSearchOrder - the model search order
      Throws:
      NullArgumentException - modelSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - modelSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getModelQueryFromInspector

      ModelQuery getModelQueryFromInspector(ModelQueryInspector modelQueryInspector)
      Gets a model query from an inspector.
      Parameters:
      modelQueryInspector - a query inspector
      Returns:
      the model query
      Throws:
      NullArgumentException - modelQueryInspector is null
      UnsupportedException - modelQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.