Interface RequestSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RequestQuery can be retrieved from this session and distributorped to this Distributor to create a virtual collection of Requests . The requests may be sequenced using the RequestSearchOrder from this session.

This Distributor has a default query that matches any request and a default search order that specifies no sequencing. The queries may be examined using a RequestQueryInspector . The query may be modified by converting the inspector back to a RequestQuery .

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canManageSmartDistributors

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

    • getRequestQuery

      RequestQuery getRequestQuery()
      Gets a request query.
      Returns:
      the request query
      Compliance:
      mandatory - This method must be implemented.

    • getRequestSearchOrder

      RequestSearchOrder getRequestSearchOrder()
      Gets a request search order.
      Returns:
      the request search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRequestQuery

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

    • inspectRequestQuery

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

    • applyRequestSequencing

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

    • getRequestQueryFromInspector

      RequestQuery getRequestQueryFromInspector(RequestQueryInspector requestQueryInspector)
      Gets a request query from an inspector.
      Parameters:
      requestQueryInspector - a request query inspector
      Returns:
      the request query
      Throws:
      NullArgumentException - requestQueryInspector is null
      UnsupportedException - requestQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.