Interface StepConstrainerEnablerSmartOfficeSession

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

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

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

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

    • getStepConstrainerEnablerQuery

      StepConstrainerEnablerQuery getStepConstrainerEnablerQuery()
      Gets a step constrainer enabler query.
      Returns:
      the step constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerEnablerSearchOrder

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

    • applyStepConstrainerEnablerQuery

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

    • inspectStepConstrainerEnablerQuery

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

    • applyStepConstrainerEnablerSequencing

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

    • getStepConstrainerEnablerQueryFromInspector

      StepConstrainerEnablerQuery getStepConstrainerEnablerQueryFromInspector(StepConstrainerEnablerQueryInspector stepConstrainerEnablerQueryInspector)
      Gets a step constrainer enabler query from an inspector.
      Parameters:
      stepConstrainerEnablerQueryInspector - a step constrainer enabler query inspector
      Returns:
      the step constrainer enabler query
      Throws:
      NullArgumentException - stepConstrainerEnablerQueryInspector is null
      UnsupportedException - stepConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.