Interface WorkflowEventQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
WorkflowEventSearchSession
public interface WorkflowEventQuerySession extends OsidSession

This session provides methods for searching among WorkflowEvents . The search query is constructed using the WorkflowEventQuery .

This session defines views that offer differing behaviors for searching.

  • federated office view: searches include workflow events in offices of which this office is an ancestor in the office hierarchy
  • isolated office view: searches are restricted to workflow events in this office

Workflow Events may have a query record indicated by their respective record types. The query record is accessed via the 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

      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.

    • canSearchWorkflowEvents

      boolean canSearchWorkflowEvents()
      Tests if this user can perform WorkflowEvent lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include workflow events in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

      void useIsolatedOfficeView()
      Isolates the view for methods in this session. An isolated view restricts searches to this office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getWorkflowEventQuery

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

    • getWorkflowEventsByQuery

      WorkflowEventList getWorkflowEventsByQuery(WorkflowEventQuery workflowEventQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of WorkflowEvents matching the given search.
      Parameters:
      workflowEventQuery - the workflow event query
      Returns:
      the returned WorkflowEventList
      Throws:
      NullArgumentException - workflowEventQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - workflowEventQuery did not originate from getWorkflowEventQuery()
      Compliance:
      mandatory - This method must be implemented.