Interface ParameterProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ParameterProcessorSearchSession
public interface ParameterProcessorQuerySession extends OsidSession

This session provides methods for searching among ParameterProcessor objects. The search query is constructed using the ParameterProcessorQuery .

This session defines views that offer differing behaviors for searching.

  • federated configuration view: searches include parameter processor in configurations of which this configuration is an ancestor in the configuration hierarchy
  • isolated configuration view: searches are restricted to parameter processor in this configuration

Parameter processor may have a query record indicated by their respective record types. The query record is accessed via the 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.

    • canSearchParameterProcessors

      boolean canSearchParameterProcessors()
      Tests if this user can perform ParameterProcessor 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.

    • useFederatedConfigurationView

      void useFederatedConfigurationView()
      Federates the view for methods in this session. A federated view will include parameter processor in configurations which are children of this broker in the configuration hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedConfigurationView

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

    • getParameterProcessorQuery

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

    • getParameterProcessorsByQuery

      ParameterProcessorList getParameterProcessorsByQuery(ParameterProcessorQuery parameterProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ParameterProcessors matching the given parameter processor query.
      Parameters:
      parameterProcessorQuery - the parameter processor query
      Returns:
      the returned ParameterProcessorList
      Throws:
      NullArgumentException - parameterProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - parameterProcessorQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.