Interface RequestTransactionSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RequestTransactionQuery can be retrieved from this session and applied to this Distributor to create a virtual collection of RequestTransactions . The request transactions may be sequenced using the RequestTransactionSearchOrder from this session.

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

  • 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.

    • getRequestTransactionQuery

      RequestTransactionQuery getRequestTransactionQuery()
      Gets a request transaction query.
      Returns:
      the request transaction query
      Compliance:
      mandatory - This method must be implemented.

    • getRequestTransactionSearchOrder

      RequestTransactionSearchOrder getRequestTransactionSearchOrder()
      Gets a request transaction search order.
      Returns:
      the request transaction search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRequestTransactionQuery

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

    • inspectRequestTransactionQuery

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

    • applyRequestTransactionSequencing

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

    • getRequestTransactionQueryFromInspector

      RequestTransactionQuery getRequestTransactionQueryFromInspector(RequestTransactionQueryInspector requestTransactionQueryInspector)
      Gets a request transaction query from an inspector.
      Parameters:
      requestTransactionQueryInspector - a request transaction query inspector
      Returns:
      the request transaction query
      Throws:
      NullArgumentException - requestTransactionQueryInspector is null
      UnsupportedException - requestTransactionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.