Interface ProcessQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProcessSearchSession
public interface ProcessQuerySession extends OsidSession

This session provides methods for searching among Processes. The search query is constructed using the ProcessQuery.

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getOfficeId

      Id getOfficeId()
      Gets the Office Id associated with this session.
      Returns:
      the Office Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getOffice

      Office getOffice() throws OperationFailedException, PermissionDeniedException
      Gets the Office associated with this session.
      Returns:
      the office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchProcesses

      boolean canSearchProcesses()
      Tests if this user can perform Process lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include processes in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

      void useIsolatedOfficeView()
      Isolates the view for methods in this session. An isolated view restricts searches to this office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getProcessQuery

      ProcessQuery getProcessQuery()
      Gets a process query.
      Returns:
      the process query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessesByQuery

      ProcessList getProcessesByQuery(ProcessQuery processQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Processes matching the given process query.
      Parameters:
      processQuery - the process query
      Returns:
      the returned ProcessList
      Throws:
      NullArgumentException - processQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.