Interface CompetencySmartFoundrySession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CompetencyQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of competencies. The competencies may be sequenced using the CompetencySearchOrder from this session.

This Foundry has a default query that matches any competency and a default search order that specifies no sequencing. The queries may be examined using a CompetencyQueryInspector . The query may be modified by converting the inspector back to a CompetencyQuery .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canManageSmartFoundries

      boolean canManageSmartFoundries()
      Tests if this user can manage smart foundries. 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 foundry management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCompetencyQuery

      CompetencyQuery getCompetencyQuery()
      Gets a competency query.
      Returns:
      the competency query
      Compliance:
      mandatory - This method must be implemented.

    • getCompetencySearchOrder

      CompetencySearchOrder getCompetencySearchOrder()
      Gets a competency search order.
      Returns:
      the competency search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCompetencyQuery

      void applyCompetencyQuery(CompetencyQuery competencyQuery) throws OperationFailedException, PermissionDeniedException
      Applies a competency query to this foundry.
      Parameters:
      competencyQuery - the competency query
      Throws:
      NullArgumentException - competencyQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - competencyQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspecCompetencyQuery

      CompetencyQueryInspector inspecCompetencyQuery() throws OperationFailedException, PermissionDeniedException
      Gets a competency query inspector for this foundry.
      Returns:
      the competency query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyCompetencySequencing

      void applyCompetencySequencing(CompetencySearchOrder competencySearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a competency search order to this foundry.
      Parameters:
      competencySearchOrder - the competency search order
      Throws:
      NullArgumentException - competencySearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - competencySearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCompetencyQueryFromInspector

      CompetencyQuery getCompetencyQueryFromInspector(CompetencyQueryInspector competencyQueryInspector)
      Gets a competency query from an inspector.
      Parameters:
      competencyQueryInspector - a competency query inspector
      Returns:
      the competency query
      Throws:
      NullArgumentException - competencyQueryInspector is null
      UnsupportedException - competencyQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.