Interface ProficiencySmartObjectiveBankSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProficiencyQuery can be retrieved from this session and mapped to this ObjectiveBank to create a virtual collection of Proficiencies . The proficiencies may be sequenced using the ProficiencySearchOrder from this session.

This ObjectiveBank has a default query that matches any proficiency and a default search order that specifies no sequencing. The queries may be examined using a ProficiencyQueryInspector . The query may be modified by converting the inspector back to a ProficiencyQuery .

  • Method Details

    • getObjectiveBankId

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

    • getObjectiveBank

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

    • canManageSmartObjectiveBanks

      boolean canManageSmartObjectiveBanks()
      Tests if this user can manage smart objective banks. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 smart operations.
      Returns:
      false if smart objective bank methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProficiencyQuery

      ProficiencyQuery getProficiencyQuery()
      Gets a proficiency query.
      Returns:
      the proficiency query
      Compliance:
      mandatory - This method must be implemented.

    • getProficiencySearchOrder

      ProficiencySearchOrder getProficiencySearchOrder()
      Gets a proficiency search order.
      Returns:
      the proficiency search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProficiencyQuery

      void applyProficiencyQuery(ProficiencyQuery proficiencyQuery) throws OperationFailedException, PermissionDeniedException
      Applies a proficiency query to this objective bank.
      Parameters:
      proficiencyQuery - the proficiency query
      Throws:
      NullArgumentException - proficiencyQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - proficiencyQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectProficiencyQuery

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

    • applyProficiencySequencing

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

    • getProficiencyQueryFromInspector

      ProficiencyQuery getProficiencyQueryFromInspector(ProficiencyQueryInspector proficiencyQueryInspector)
      Gets a proficiency query from an inspector.
      Parameters:
      proficiencyQueryInspector - a proficiency query inspector
      Returns:
      the proficiency query
      Throws:
      NullArgumentException - relatinshipQueryInspector is null
      UnsupportedException - proficiencyQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.