Interface WorkflowEventSmartOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A WorkflowEventQuery can be retrieved from this session and mapped to this Office to create a virtual collection of WorkflowEvents . The workflow events may be sequenced using the WorkflowEventSearchOrder from this session.

This Office has a default query that matches any workflow event and a default search order that specifies no sequencing. The queries may be examined using a WorkflowEventQueryInspector. T he query may be modified by converting the inspector back to a WorkflowEventQuery .

  • 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

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

    • getWorkflowEventQuery

      WorkflowEventQuery getWorkflowEventQuery()
      Gets a workflow event query.
      Returns:
      the workflow event query
      Compliance:
      mandatory - This method must be implemented.

    • getWorkflowEventSearchOrder

      WorkflowEventSearchOrder getWorkflowEventSearchOrder()
      Gets a workflow event search order.
      Returns:
      the workflow event search order
      Compliance:
      mandatory - This method must be implemented.

    • applyWorkflowEventQuery

      void applyWorkflowEventQuery(WorkflowEventQuery workflowEventQuery) throws OperationFailedException, PermissionDeniedException
      Applies a workflow event query to this office.
      Parameters:
      workflowEventQuery - the workflow event query
      Throws:
      NullArgumentException - workflowEventQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - workflowEventQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectWorkflowEventQuery

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

    • applyWorkflowEventSequencing

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

    • getWorkflowEventQueryFromInspector

      WorkflowEventQuery getWorkflowEventQueryFromInspector(WorkflowEventQueryInspector workflowEventQueryInspector)
      Gets a workflow event query from an inspector.
      Parameters:
      workflowEventQueryInspector - a workflow event query inspector
      Returns:
      the workflow event query
      Throws:
      NullArgumentException - workflowEventQueryInspector is null
      UnsupportedException - workflowEventQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.