Interface ProcessSearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface ProcessSearch extends OsidSearch

The search interface for governing process searches.

  • Method Details

    • searchAmongProcesses

      void searchAmongProcesses(IdList processIds)
      Execute this search among the given list of processes.
      Parameters:
      processIds - list of processes
      Throws:
      NullArgumentException - processIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderProcessResults

      void orderProcessResults(ProcessSearchOrder processSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      processSearchOrder - process search order
      Throws:
      NullArgumentException - processSearchOrder is null
      UnsupportedException - processSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProcessSearchRecord

      ProcessSearchRecord getProcessSearchRecord(Type processSearchRecordType) throws OperationFailedException
      Gets the process search record corresponding to the given process search record Type. This method is used to retrieve an object implementing the requested record.
      Parameters:
      processSearchRecordType - a process search record type
      Returns:
      the process search record
      Throws:
      NullArgumentException - processSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(processSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.