Interface ProcessProcessorSmartOfficeSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ProcessProcessorSmartOfficeSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProcessProcessorQuery can be retrieved from this session and mapped to this Office to create a virtual collection of ProcessProcessors . The process processors may be sequenced using the ProcessProcessorSearchOrder from this session.

This Office has a default query that matches any process processor and a default search order that specifies no sequencing. The queries may be examined using a ProcessProcessorQueryInspector . The query may be modified by converting the inspector back to a 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.

    • canManageSmartOffices

      boolean canManageSmartOffices()
      Tests if this user can manage smart offices. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart office management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorQuery

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

    • getProcessProcessorSearchOrder

      ProcessProcessorSearchOrder getProcessProcessorSearchOrder()
      Gets a process processor search order.
      Returns:
      the process processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProcessProcessorQuery

      void applyProcessProcessorQuery(ProcessProcessorQuery processProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Applies a process processor query to this office.
      Parameters:
      processProcessorQuery - the process processor query
      Throws:
      NullArgumentException - processProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - processProcessorQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectProcessProcessorQuery

      ProcessProcessorQueryInspector inspectProcessProcessorQuery() throws OperationFailedException, PermissionDeniedException
      Gets a process processor query inspector for this office.
      Returns:
      the process processor query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyProcessProcessorSequencing

      void applyProcessProcessorSequencing(ProcessProcessorSearchOrder processProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a process processor search order to this office.
      Parameters:
      processProcessorSearchOrder - the process processor search order
      Throws:
      NullArgumentException - processProcessorSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - processProcessorSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorQueryFromInspector

      ProcessProcessorQuery getProcessProcessorQueryFromInspector(ProcessProcessorQueryInspector processProcessorQueryInspector)
      Gets a process processor query from an inspector.
      Parameters:
      processProcessorQueryInspector - a process processor query inspector
      Returns:
      the process processor query
      Throws:
      NullArgumentException - processProcessorQueryInspector is null
      UnsupportedException - processProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.