Interface WorkflowEventSearchSession

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

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

getWorkflowEventsByQuery() is the basic search method and returns a list of WorkflowEvents . A more advanced search may be performed with getWorkflowEventsBySearch() .It accepts a WorkflowEventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getWorkflowEventsBySearch() returns a WorkflowEventSearchResults that can be used to access the resulting WorkflowEventList or be used to perform a search within the result set through WorkflowEventSearch .

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

    • getWorkflowEventSearch

      WorkflowEventSearch getWorkflowEventSearch()
      Gets a workflow event search.
      Returns:
      the workflow event search
      Compliance:
      mandatory - This method must be implemented.

    • getWorkflowEventSearchOrder

      WorkflowEventSearchOrder getWorkflowEventSearchOrder()
      Gets a workflow event search order. The WorkflowEventSearchOrder is supplied to a WorkflowEventSearch to specify the ordering of results.
      Returns:
      the workflow event search order
      Compliance:
      mandatory - This method must be implemented.

    • getWorkflowEventsBySearch

      WorkflowEventSearchResults getWorkflowEventsBySearch(WorkflowEventQuery workflowEventQuery, WorkflowEventSearch workflowEventSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      workflowEventQuery - the workflow event query
      workflowEventSearch - the workflow event search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - workflowEventQuery or workflowEventSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - workflowEventQuery or workflowEventSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getWorkflowEventQueryFromInspector

      WorkflowEventQuery getWorkflowEventQueryFromInspector(WorkflowEventQueryInspector workflowEventQueryInspector)
      Gets a workflow event query from an inspector. The inspector is available from a WorkflowEventSearchResults .
      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.