Interface ParameterProcessorSearchSession

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

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

getParameterProcessorsByQuery() is the basic search method and returns a list of ParameterProcessors . A more advanced search may be performed with getParameterProcessorsBySearch() . It accepts a ParameterProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as configuration. getParameterProcessorsBySearch() returns a ParameterProcessorSearchResults that can be used to access the resulting ParameterProcessorList or be used to perform a search within the result set through ParameterProcessorSearch .

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

  • Method Details

    • getParameterProcessorSearch

      ParameterProcessorSearch getParameterProcessorSearch()
      Gets a parameter processor search.
      Returns:
      the parameter processor search
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorSearchOrder

      ParameterProcessorSearchOrder getParameterProcessorSearchOrder()
      Gets a parameter processor search order. The ParameterProcessorSearchOrder is supplied to a ParameterProcessorSearch to specify the ordering of results.
      Returns:
      the parameter processor search order
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsBySearch

      ParameterProcessorSearchResults getParameterProcessorsBySearch(ParameterProcessorQuery parameterProcessorQuery, ParameterProcessorSearch parameterProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      parameterProcessorQuery - the parameter processor query
      parameterProcessorSearch - the parameter processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - parameterProcessorQuery or parameterProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - parameterProcessorQuery or parameterProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorQueryFromInspector

      ParameterProcessorQuery getParameterProcessorQueryFromInspector(ParameterProcessorQueryInspector parameterProcessorQueryInspector)
      Gets a parameter processor query from an inspector. The inspector is available from a ParameterProcessorSearchResults .
      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.