Interface ProcessConstrainerEnablerSmartOfficeSession

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

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

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

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

    • getProcessConstrainerEnablerQuery

      ProcessConstrainerEnablerQuery getProcessConstrainerEnablerQuery()
      Gets a process constrainer enabler query.
      Returns:
      the process constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablerSearchOrder

      ProcessEnablerSearchOrder getProcessConstrainerEnablerSearchOrder()
      Gets a process constrainer enabler search order.
      Returns:
      the process constrainer enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProcessConstrainerEnablerQuery

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

    • inspectProcessConstrainerEnablerQuery

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

    • applyProcessConstrainerEnablerSequencing

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

    • getProcessConstrainerEnablerQueryFromInspector

      ProcessConstrainerEnablerQuery getProcessConstrainerEnablerQueryFromInspector(ProcessConstrainerEnablerQueryInspector processConstrainerEnablerQueryInspector)
      Gets a process constrainer enabler query from an inspector.
      Parameters:
      processConstrainerEnablerQueryInspector - a process constrainer enabler query inspector
      Returns:
      the process constrainer enabler query
      Throws:
      NullArgumentException - processConstrainerEnablerQueryInspector is null
      UnsupportedException - processConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.