Interface ProcessConstrainerEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProcessConstrainerEnablerQuerySession
public interface ProcessConstrainerEnablerSearchSession extends ProcessConstrainerEnablerQuerySession

This session provides methods for searching among ProcessConstrainerEnablers . The search query is constructed using the ProcessConstrainerEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getProcessConstrainerEnablerSearch

      ProcessConstrainerEnablerSearch getProcessConstrainerEnablerSearch()
      Gets a process constrainer enabler search.
      Returns:
      the process constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablerSearchOrder

      ProcessConstrainerEnablerSearchOrder getProcessConstrainerEnablerSearchOrder()
      Gets a process constrainer enabler search order. The ProcessConstrainerEnablerSearchOrder is supplied to a ProcessConstrainerEnablerSearch to specify the ordering of results.
      Returns:
      the process constrainer enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablersBySearch

      ProcessConstrainerEnablerSearchResults getProcessConstrainerEnablersBySearch(ProcessEnablerQuery processConstrainerEnablerQuery, ProcessConstrainerEnablerSearch processConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      processConstrainerEnablerQuery - the process constrainer enabler query
      processConstrainerEnablerSearch - the process constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - processConstrainerEnablerQuery or processConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processConstrainerEnablerQuery or processConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablerQueryFromInspector

      ProcessConstrainerEnablerQuery getProcessConstrainerEnablerQueryFromInspector(ProcessConstrainerEnablerQueryInspector processConstrainerEnablerQueryInspector)
      Gets a process constrainer enabler query from an inspector. The inspector is available from a ProcessConstrainerEnablerSearchResults .
      Parameters:
      processConstrainerEnablerQueryInspector - a process constrainer enabler query inspector
      Returns:
      the process constrainer enabler query
      Throws:
      NullArgumentException - processConstrainerEnablerQueryInspector is null
      UnsupportedException - processConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.