Interface SequenceRuleSmartBankSession

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

This session manages queries and sequencing to create "smart" dynamic bank. a SequenceRuleQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of sequence rules. The sequence rule may be sequenced using the SequenceRuleSearchOrder from this session.

This Bank has a default query that matches any sequence rule and a default search order that specifies no sequencing. The queries may be examined using a SequenceRuleQueryInspector. The query may be modified by converting the inspector back to a SequenceRuleQuery.

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

  • Method Details

    • getBankId

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

    • getBank

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

    • canManageSmartBanks

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

    • getSequenceRuleQuery

      SequenceRuleQuery getSequenceRuleQuery()
      Gets a sequence rule query.
      Returns:
      the sequence rule query
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleSearchOrder

      SequenceRuleSearchOrder getSequenceRuleSearchOrder()
      Gets a sequence rule search order.
      Returns:
      the sequence rule search order
      Compliance:
      mandatory - This method must be implemented.

    • applySequenceRuleQuery

      void applySequenceRuleQuery(SequenceRuleQuery sequenceRuleQuery) throws OperationFailedException, PermissionDeniedException
      Applies a sequence rule query to this bank.
      Parameters:
      sequenceRuleQuery - the sequence rule query
      Throws:
      NullArgumentException - sequenceRuleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - sequenceRuleQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectSequenceRuleQuery

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

    • applySequenceRuleSequencing

      void applySequenceRuleSequencing(SequenceRuleSearchOrder sequenceRuleSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a sequence rule search order to this bank.
      Parameters:
      sequenceRuleSearchOrder - the sequence rule search order
      Throws:
      NullArgumentException - sequenceRuleSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - sequenceRuleSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleQueryFromInspector

      SequenceRuleQuery getSequenceRuleQueryFromInspector(SequenceRuleQueryInspector sequenceRuleQueryInspector)
      Gets a sequence rule query from an inspector.
      Parameters:
      sequenceRuleQueryInspector - a sequence rule query inspector
      Returns:
      the sequence rule query
      Throws:
      NullArgumentException - sequenceRuleQueryInspector is null
      UnsupportedException - sequenceRuleQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.