Interface ProficiencyQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProficiencySearchSession
public interface ProficiencyQuerySession extends OsidSession

This session provides methods for searching among Proficiencies. The search query is constructed using the ProficiencyQuery.

This session defines views that offer differing behaviors for searching.

  • federated objective bank view: searches include proficiencies in objective banks of which this objective bank is an ancestor in the obective bank hierarchy
  • isolated objective bank view: searches are restricted to proficiencies in this objective bank

Proficiencies may have a query record indicated by their respective record types. The query record is accessed via the ProficiencyQuery.

  • Method Details

    • getObjectiveBankId

      Id getObjectiveBankId()
      Gets the ObjectiveBank 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.

    • canSearchProficiencies

      boolean canSearchProficiencies()
      Tests if this user can perform Proficiency lookups. 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedObjectiveBankView

      void useFederatedObjectiveBankView()
      Federates the view for methods in this session. A federated view will include proficiencies in objective banks which are children of this objective bank in the obective bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedObjectiveBankView

      void useIsolatedObjectiveBankView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this objective bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • getProficiencyQuery

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

    • getProficienciesByQuery

      ProficiencyList getProficienciesByQuery(ProficiencyQuery proficiencyQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Proficiencies matching the given proficiency query.
      Parameters:
      proficiencyQuery - the proficiency query
      Returns:
      the returned ProficiencyList
      Throws:
      NullArgumentException - proficiencyQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - proficiencyQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.