Interface AssessmentOfferedSmartBankSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssessmentOfferedQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of AssessmentsOffered . 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 AssessmentOfferedQueryInspector . The query may be modified by converting the inspector back to an AssessmentOfferedQuery .

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

    • getAssessmentOfferedQuery

      AssessmentOfferedQuery getAssessmentOfferedQuery()
      Gets an assessment offered query.
      Returns:
      the assessment offered query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentOfferedSearchOrder

      AssessmentOfferedSearchOrder getAssessmentOfferedSearchOrder()
      Gets an assessment offered search order.
      Returns:
      the assessment offered search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAssessmentOfferedQuery

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

    • inspectAssessmentOfferedQuery

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

    • applyAssessmentOfferedSequencing

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

    • getAssessmentOfferedQueryFromInspector

      AssessmentOfferedQuery getAssessmentOfferedQueryFromInspector(AssessmentOfferedQueryInspector assessmentOfferedQueryInspector)
      Gets an assessment offered query from an inspector.
      Parameters:
      assessmentOfferedQueryInspector - an assessment offered query inspector
      Returns:
      the assessment offered query
      Throws:
      NullArgumentException - assessmentOfferedQueryInspector is null
      UnsupportedException - assessmentOfferedQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.