Interface ParameterProcessorSmartConfigurationSession

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

This session manages queries and sequencing to create "smart" dynamic configurations. A ParameterProcessorQuery can be retrieved from this session and mapped to this Configuration to create a virtual collection of parameter processors. The parameter processor may be sequenced using the ParameterProcessorSearchOrder from this session.

This Configuration has a default query that matches any parameter processor and a default search order that specifies no sequencing. The queries may be examined using a ParameterProcessorQueryInspector . The query may be modified by converting the inspector back to a ParameterProcessorQuery .

  • Method Details

    • getConfigurationId

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

    • getConfiguration

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

    • canManageSmartConfigurations

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

    • getParameterProcessorQuery

      ParameterProcessorQuery getParameterProcessorQuery()
      Gets a parameter processor query.
      Returns:
      the parameter processor query
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorSearchOrder

      ParameterProcessorSearchOrder getParameterProcessorSearchOrder()
      Gets a parameter processor search order.
      Returns:
      the parameter processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyParameterProcessorQuery

      void applyParameterProcessorQuery(ParameterProcessorQuery parameterProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Applies a parameter processor query to this configuration.
      Parameters:
      parameterProcessorQuery - the parameter processor query
      Throws:
      NullArgumentException - parameterProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - parameterProcessorQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectParameterProcessorQuery

      ParameterProcessorQueryInspector inspectParameterProcessorQuery() throws OperationFailedException, PermissionDeniedException
      Gets a parameter processor query inspector for this configuration.
      Returns:
      the parameter processor query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyParameterProcessorSequencing

      void applyParameterProcessorSequencing(ParameterProcessorSearchOrder parameterProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a parameter processor search order to this configuration.
      Parameters:
      parameterProcessorSearchOrder - the parameter processor search order
      Throws:
      NullArgumentException - parameterProcessorSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - parameterProcessorSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorQueryFromInspector

      ParameterProcessorQuery getParameterProcessorQueryFromInspector(ParameterProcessorQueryInspector parameterProcessorQueryInspector)
      Gets a parameter processor query from an inspector.
      Parameters:
      parameterProcessorQueryInspector - a parameter processor query inspector
      Returns:
      the parameter processor query
      Throws:
      NullArgumentException - parameterProcessorQueryInspector is null
      UnsupportedException - parameterProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.