Interface ProcessProcessorSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProcessProcessorQuerySession
public interface ProcessProcessorSearchSession extends ProcessProcessorQuerySession

This session provides methods for searching among ProcessProcessors . The search query is constructed using the ProcessProcessorQuery .

getProcessProcessorsByQuery() is the basic search method and returns a list of ProcessProcessors . A more advanced search may be performed with getProcessProcessorsBySearch() . It accepts a ProcessProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProcessProcessorsBySearch() returns a ProcessProcessorSearchResults that can be used to access the resulting ProcessProcessorList or be used to perform a search within the result set through ProcessProcessorSearch .

This session defines views that offer differing behaviors for searching.

  • federated office view: searches include process processors in offices of which this office is an ancestor in the office hierarchy
  • isolated office view: searches are restricted to process processors in this office

Process processors may have a query record indicated by their respective record types. The query record is accessed via the ProcessProcessorQuery .

  • Method Details

    • getProcessProcessorSearch

      ProcessProcessorSearch getProcessProcessorSearch()
      Gets a process processor search.
      Returns:
      the process processor search
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorSearchOrder

      ProcessProcessorSearchOrder getProcessProcessorSearchOrder()
      Gets a process processor search order. The ProcessProcessorSearchOrder is supplied to a ProcessProcessorSearch to specify the ordering of results.
      Returns:
      the process processor search order
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorsBySearch

      ProcessProcessorSearchResults getProcessProcessorsBySearch(ProcessProcessorQuery processProcessorQuery, ProcessProcessorSearch processProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      processProcessorQuery - the process processor query
      processProcessorSearch - the process processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - processProcessorQuery or processProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processProcessorQuery or processProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorQueryFromInspector

      ProcessProcessorQuery getProcessProcessorQueryFromInspector(ProcessProcessorQueryInspector processProcessorQueryInspector)
      Gets a process processor query from an inspector. The inspector is available from a ProcessProcessorSearchResults .
      Parameters:
      processProcessorQueryInspector - a process processor query inspector
      Returns:
      the process processor query
      Throws:
      NullArgumentException - processProcessorQueryInspector is null
      UnsupportedException - processProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.