Interface ProcessProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProcessProcessorSearchSession
public interface ProcessProcessorQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

  • 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.

    • canSearchProcessProcessors

      boolean canSearchProcessProcessors()
      Tests if this user can perform ProcessProcessor searches. 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 process processors 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.

    • getProcessProcessorQuery

      ProcessProcessorQuery getProcessProcessorQuery()
      Gets a process processor query.
      Returns:
      the process processor query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorsByQuery

      ProcessProcessorList getProcessProcessorsByQuery(ProcessProcessorQuery processProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ProcessProcessors matching the given search.
      Parameters:
      processProcessorQuery - the process processor query
      Returns:
      a list of process processors
      Throws:
      NullArgumentException - processProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processProcessorQuery did not originate from getProcessProcessorQuery()
      Compliance:
      mandatory - This method must be implemented.