Interface StepProcessorSmartOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic office. a StepProcessorQuery can be retrieved from this session and mapped to this Office to create a virtual collection of step processors. The step processor may be sequenced using the StepProcessorSearchOrder from this session.

This Office has a default query that matches any step processor and a default search order that specifies no sequencing. The queries may be examined using a StepProcessorQueryInspector . The query may be modified by converting the inspector back to a StepProcessorQuery .

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

    • getStepProcessorQuery

      StepProcessorQuery getStepProcessorQuery()
      Gets a step processor query.
      Returns:
      the step processor query
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorSearchOrder

      StepProcessorSearchOrder getStepProcessorSearchOrder()
      Gets a step processor search order.
      Returns:
      the step processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyStepProcessorQuery

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

    • inspectStepProcessorQuery

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

    • applyStepProcessorSequencing

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

    • getStepProcessorQueryFromInspector

      StepProcessorQuery getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)
      Gets a step processor query from an inspector.
      Parameters:
      stepProcessorQueryInspector - a step processor query inspector
      Returns:
      the step processor query
      Throws:
      NullArgumentException - stepProcessorQueryInspector is null
      UnsupportedException - stepProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.