Interface AssessmentTakenSmartBankSession

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

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

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

    • getAssessmentTakenQuery

      AssessmentTakenQuery getAssessmentTakenQuery()
      Gets an assessment taken query.
      Returns:
      the assessment taken query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentTakenSearchOrder

      AssessmentTakenSearchOrder getAssessmentTakenSearchOrder()
      Gets an assessment taken search order.
      Returns:
      the assessment taken search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAssessmentTakenQuery

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

    • inspectAssessmentTakenQuery

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

    • applyAssessmentTakenSequencing

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

    • getAssessmentTakenQueryFromInspector

      AssessmentTakenQuery getAssessmentTakenQueryFromInspector(AssessmentTakenQueryInspector assessmenTakenQueryInspector)
      Gets an assessment taken query from an inspector.
      Parameters:
      assessmenTakenQueryInspector - an assessment taken query inspector
      Returns:
      the assessment taken query
      Throws:
      NullArgumentException - assessmenTakenQueryInspector is null
      UnsupportedException - assessmenTakenQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.