Interface AssessmentSmartBankSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssessmentQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of Assessments . The assessments may be sequenced using the AssessmentSearchOrder from this session.

This Bank has a default query that matches any assessment and a default search order that specifies no sequencing. The queries may be examined using an AssessmentQueryInspector . The query may be modified by converting the inspector back to an AssessmentQuery .

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - assessment failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartBanks

      boolean canManageSmartBanks()
      Tests if this user can manage smart banks. 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.

    • getAssessmentQuery

      AssessmentQuery getAssessmentQuery()
      Gets an assessment query.
      Returns:
      the assessment query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentSearchOrder

      AssessmentSearchOrder getAssessmentSearchOrder()
      Gets an assessment search order.
      Returns:
      the assessment search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAssessmentQuery

      void applyAssessmentQuery(AssessmentQuery assessmentQuery) throws OperationFailedException, PermissionDeniedException
      Applies an assessment query to this bank.
      Parameters:
      assessmentQuery - the assessment query
      Throws:
      NullArgumentException - assessmentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectAssessmentQuery

      AssessmentQueryInspector inspectAssessmentQuery() throws OperationFailedException, PermissionDeniedException
      Gets an assessment query inspector for this bank.
      Returns:
      the assessment query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyAssessmentSequencing

      void applyAssessmentSequencing(AssessmentSearchOrder assessmentSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an assessment search order to this bank.
      Parameters:
      assessmentSearchOrder - the assessment search order
      Throws:
      NullArgumentException - assessmentSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentQueryFromInspector

      AssessmentQuery getAssessmentQueryFromInspector(AssessmentQueryInspector assessmentQueryInspector)
      Gets an assessment query from an inspector.
      Parameters:
      assessmentQueryInspector - an assessment query inspector
      Returns:
      the assessment query
      Throws:
      NullArgumentException - assessmentQueryInspector is null
      UnsupportedException - assessmentQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.