Interface StepConstrainerSmartOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic office. a StepConstrainerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of step constrainers. The step constrainer may be sequenced using the StepConstrainerSearchOrder from this session.

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

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

    • getStepConstrainerQuery

      StepConstrainerQuery getStepConstrainerQuery()
      Gets a step constrainer query.
      Returns:
      the step constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerSearchOrder

      StepConstrainerSearchOrder getStepConstrainerSearchOrder()
      Gets a step constrainer search order.
      Returns:
      the step constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyStepConstrainerQuery

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

    • inspectStepConstrainerQuery

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

    • applyStepConstrainerSequencing

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

    • getStepConstrainerQueryFromInspector

      StepConstrainerQuery getStepConstrainerQueryFromInspector(StepConstrainerQueryInspector stepConstrainerQueryInspector)
      Gets a step constrainer query from an inspector.
      Parameters:
      stepConstrainerQueryInspector - a step constrainer query inspector
      Returns:
      the step constrainer query
      Throws:
      NullArgumentException - stepConstrainerQueryInspector is null
      UnsupportedException - stepConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.