Interface ProcessConstrainerSmartOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProcessConstrainerQuery can be retrieved from this session and mapped to this Office to create a virtual collection of ProcessConstrainers . The process constrainers may be sequenced using the ProcessConstrainerSearchOrder from this session.

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

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

    • getProcessConstrainerQuery

      ProcessConstrainerQuery getProcessConstrainerQuery()
      Gets a process constrainer query.
      Returns:
      the process constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerSearchOrder

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

    • applyProcessConstrainerQuery

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

    • inspectProcessConstrainerQuery

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

    • applyProcessConstrainerSequencing

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

    • getProcessConstrainerQueryFromInspector

      ProcessConstrainerQuery getProcessConstrainerQueryFromInspector(ProcessConstrainerQueryInspector processConstrainerQueryInspector)
      Gets a process constrainer query from an inspector.
      Parameters:
      processConstrainerQueryInspector - a process constrainer query inspector
      Returns:
      the process constrainer query
      Throws:
      NullArgumentException - processConstrainerQueryInspector is null
      UnsupportedException - processConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.