Interface ProcessProcessorEnablerSmartOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProcessProcessorEnablerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of ProcessProcessorEnablers. The process processor enablers may be sequenced using the ProcessProcessorEnablerSearchOrder from this session.

This Office has a default query that matches any process processor enabler and a default search order that specifies no sequencing. The queries may be examined using a ProcessProcessorEnablerQueryInspector. Th e query may be modified by converting the inspector back to a ProcessProcessorEnablerQuery.

Like all OsidSessions, ProcessProcessorEnablerSmartOfficeSessions are dedicated to single processing threads and a single authenticated user.

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

    • getProcessProcessorEnablerQuery

      ProcessProcessorEnablerQuery getProcessProcessorEnablerQuery()
      Gets a process processor enabler query.
      Returns:
      the process processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablerSearchOrder

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

    • applyProcessProcessorEnablerQuery

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

    • inspectProcessProcessorEnablerQuery

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

    • applyProcessProcessorEnablerSequencing

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

    • getProcessProcessorEnablerQueryFromInspector

      ProcessProcessorEnablerQuery getProcessProcessorEnablerQueryFromInspector(ProcessProcessorEnablerQueryInspector processProcessorEnablerQueryInspector)
      Gets a process processor enabler query from an inspector.
      Parameters:
      processProcessorEnablerQueryInspector - a process processor enabler query inspector
      Returns:
      the process processor enabler query
      Throws:
      NullArgumentException - processProcessorEnablerQueryInspector is null
      UnsupportedException - processProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.