Interface WorkflowEventSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface WorkflowEventSearchOrder extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByTimestamp

      void orderByTimestamp(SearchOrderStyle style)
      Orders the results by timestamp.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByProcess

      void orderByProcess(SearchOrderStyle style)
      Orders the results by process.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessSearchOrder

      boolean supportsProcessSearchOrder()
      Tests if a process search order is available.
      Returns:
      true if a process search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProcessSearchOrder

      ProcessSearchOrder getProcessSearchOrder()
      Gets the process search order.
      Returns:
      the process search order
      Throws:
      IllegalStateException - supportsProcessSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByWorker

      void orderByWorker(SearchOrderStyle style)
      Orders the results by worker.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkerSearchOrder

      boolean supportsWorkerSearchOrder()
      Tests if a worker resource search order is available.
      Returns:
      true if a resource search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getWorkerSearchOrder

      ResourceSearchOrder getWorkerSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsWorkerSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByWorkingAgent

      void orderByWorkingAgent(SearchOrderStyle style)
      Orders the results by working agent.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkingAgentSearchOrder

      boolean supportsWorkingAgentSearchOrder()
      Tests if a working agent search order is available.
      Returns:
      true if an agent search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getWorkingAgentSearchOrder

      AgentSearchOrder getWorkingAgentSearchOrder()
      Gets the agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsWorkingAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByWork

      void orderByWork(SearchOrderStyle style)
      Orders the results by work.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkSearchOrder

      boolean supportsWorkSearchOrder()
      Tests if a work search order is available.
      Returns:
      true if a work search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getWorkSearchOrder

      WorkSearchOrder getWorkSearchOrder()
      Gets the work search order.
      Returns:
      the work search order
      Throws:
      IllegalStateException - supportsWorkSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCancaled

      void orderByCancaled(SearchOrderStyle style)
      Orders the results by the canceled flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByStep

      void orderByStep(SearchOrderStyle style)
      Orders the results by step.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepSearchOrder

      boolean supportsStepSearchOrder()
      Tests if a step search order is available.
      Returns:
      true if a step search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStepSearchOrder

      StepSearchOrder getStepSearchOrder()
      Gets the step search order.
      Returns:
      the step search order
      Throws:
      IllegalStateException - supportsStepSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • getWorkflowEventSearchOrderRecord

      WorkflowEventSearchOrderRecord getWorkflowEventSearchOrderRecord(Type workflowEventRecordType) throws OperationFailedException
      Gets the workflow event search order record corresponding to the given workflow event record Type . Multiple retrievals return the same underlying object.
      Parameters:
      workflowEventRecordType - a workflow event record type
      Returns:
      the workflow event search order record
      Throws:
      NullArgumentException - workflowEventRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(workflowEventRecordType) is false
      Compliance:
      mandatory - This method must be implemented.