Interface ProcessProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProcessProcessorEnablerQuerySession
public interface ProcessProcessorEnablerSearchSession extends ProcessProcessorEnablerQuerySession

This session provides methods for searching among ProcessProcessorEnablers . The search query is constructed using the ProcessProcessorEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

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

Process processor enablers may have a query record indicated by their respective record types. The query record is accessed via the ProcessProcessorEnablerQuery .

  • Method Details

    • getProcessProcessorEnablerSearch

      ProcessProcessorEnablerSearch getProcessProcessorEnablerSearch()
      Gets a process processor enabler search.
      Returns:
      the process processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablerSearchOrder

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

    • getProcessProcessorEnablersBySearch

      ProcessProcessorEnablerSearchResults getProcessProcessorEnablersBySearch(ProcessProcessorEnablerQuery processProcessorEnablerQuery, ProcessProcessorEnablerSearch processProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      processProcessorEnablerQuery - the process processor enabler query
      processProcessorEnablerSearch - the process processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - processProcessorEnablerQuery or processProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processProcessorEnablerQuery or processProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablerQueryFromInspector

      ProcessProcessorEnablerQuery getProcessProcessorEnablerQueryFromInspector(ProcessProcessorEnablerQueryInspector processProcessorEnablerQueryInspector)
      Gets a process processor enabler query from an inspector. The inspector is available from a ProcessProcessorEnablerSearchResults .
      Parameters:
      processProcessorEnablerQueryInspector - a process processor enabler query inspector
      Returns:
      the process processor enabler query
      Throws:
      NullArgumentException - processProcessorEnablerQueryInspector is null
      UnsupportedException - processProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.