Interface ProcessConstrainerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProcessConstrainerQuerySession
public interface ProcessConstrainerSearchSession extends ProcessConstrainerQuerySession

This session provides methods for searching among ProcessConstrainers . The search query is constructed using the ProcessConstrainerQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getProcessConstrainerSearch

      ProcessConstrainerSearch getProcessConstrainerSearch()
      Gets a process constrainer search.
      Returns:
      the process constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerSearchOrder

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

    • getProcessConstrainersBySearch

      ProcessConstrainerSearchResults getProcessConstrainersBySearch(ProcessConstrainerQuery processConstrainerQuery, ProcessConstrainerSearch processConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      processConstrainerQuery - the process constrainer query
      processConstrainerSearch - the process constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - processConstrainerQuery or processConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processConstrainerQuery or processConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerQueryFromInspector

      ProcessConstrainerQuery getProcessConstrainerQueryFromInspector(ProcessConstrainerQueryInspector processConstrainerQueryInspector)
      Gets a process constrainer query from an inspector. The inspector is available from a ProcessConstrainerSearchResults .
      Parameters:
      processConstrainerQueryInspector - a process constrainer query inspector
      Returns:
      the process constrainer query
      Throws:
      NullArgumentException - processConstrainerQueryInspector is null
      UnsupportedException - processConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.