Interface StepProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, StepProcessorEnablerQuerySession
public interface StepProcessorEnablerSearchSession extends StepProcessorEnablerQuerySession

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

getStepProcessorEnablersByQuery() is the basic search method and returns a list of StepProcessorEnablers. A more advanced search may be performed with getStepProcessorEnablersBySearch(). It accepts a StepProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getStepProcessorEnablersBySearch() returns a StepProcessorEnablerSearchResults that can be used to access the resulting StepProcessorEnablerList or be used to perform a search within the result set through StepProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated office view: searches include step processor enablers in office of which this office is an ancestor in the office hierarchy
  • isolated office view: searches are restricted to step processor enablers in this office
StepProcessorEnablers may have a query record indicated by their respective query record types. The record is accessed via the StepProcessorEnablerQuery.

  • Method Details

    • getStepProcessorEnablerSearch

      StepProcessorEnablerSearch getStepProcessorEnablerSearch()
      Gets a step processor enabler search.
      Returns:
      the step processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorEnablerSearchOrder

      StepProcessorEnablerSearchOrder getStepProcessorEnablerSearchOrder()
      Gets a step processor enabler search order. The StepProcessorEnablerSearchOrder is supplied to a StepProcessorEnablerSearch to specify the ordering of results.
      Returns:
      the step processor enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorEnablersBySearch

      StepProcessorEnablerSearchResults getStepProcessorEnablersBySearch(StepProcessorEnablerQuery stepProcessorEnablerQuery, StepProcessorEnablerSearch stepProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      stepProcessorEnablerQuery - the step processor enabler query
      stepProcessorEnablerSearch - the step processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - stepProcessorEnablerQuery or stepProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepProcessorEnablerQuery or stepProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorEnablerQueryFromInspector

      StepProcessorEnablerQuery getStepProcessorEnablerQueryFromInspector(StepProcessorEnablerQueryInspector stepProcessorEnablerQueryInspector)
      Gets a step processor enabler query from an inspector. The inspector is available from a StepProcessorEnablerSearchResults.
      Parameters:
      stepProcessorEnablerQueryInspector - a step processor enabler query inspector
      Returns:
      the step processor enabler query
      Throws:
      NullArgumentException - stepProcessorEnablerQueryInspector is null
      UnsupportedException - stepProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.