Interface StepEnablerSmartOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A StepEnablerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of StepEnablers . The step enablers may be sequenced using the StepEnablerSearchOrder from this session.

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

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

    • getStepEnablerQuery

      StepEnablerQuery getStepEnablerQuery()
      Gets a step enabler query.
      Returns:
      the step enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getStepEnablerSearchOrder

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

    • applyStepEnablerQuery

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

    • inspectStepEnablerQuery

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

    • applyStepEnablerSequencing

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

    • getStepEnablerQueryFromInspector

      StepQuery getStepEnablerQueryFromInspector(StepEnablerQueryInspector stepEnablerQueryInspector)
      Gets a step enabler query from an inspector.
      Parameters:
      stepEnablerQueryInspector - a step enabler query inspector
      Returns:
      the step enabler query
      Throws:
      NullArgumentException - stepEnablerQueryInspector is null
      UnsupportedException - stepEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.