Interface CommissionSmartFoundrySession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CommissionQuery can be retrieved from this session and foundryped to this Foundry to create a virtual collection of Commissions . The commissions may be sequenced using the CommissionSearchOrder from this session.

This Foundry has a default query that matches any commission and a default search order that specifies no sequencing. The queries may be examined using a CommissionQueryInspector . The query may be modified by converting the inspector back to a CommissionQuery .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canManageSmartFoundries

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

    • getCommissionQuery

      CommissionQuery getCommissionQuery()
      Gets a commission query.
      Returns:
      the commission query
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionSearchOrder

      CommissionSearchOrder getCommissionSearchOrder()
      Gets a commission search order.
      Returns:
      the commission search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCommissionQuery

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

    • inspectCommissionQuery

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

    • applyCommissionSequencing

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

    • getCommissionQueryFromInspector

      CommissionQuery getCommissionQueryFromInspector(CommissionQueryInspector commissionQueryInspector)
      Gets a commission query from an inspector.
      Parameters:
      commissionQueryInspector - a commission query inspector
      Returns:
      the commission query
      Throws:
      NullArgumentException - commissionQueryInspector is null
      UnsupportedException - commissionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.