FlowHandle
Keywords: net.corda.core.messaging.FlowHandle interface
Date: 2023-09-18

net.corda.core.messaging

## Interface FlowHandle<A>

- All Known Subinterfaces:
    FlowHandleWithClientId<A>, FlowProgressHandle<A>
  All Known Implementing Classes:
    FlowHandleImpl, FlowHandleWithClientIdImpl, FlowProgressHandleImpl

      @DoNotImplement
      public FlowHandle<A>

  `interface FlowHandle` is a serialisable handle for the started flow, parameterised by the type of the flow's return value.

  See Also:
    `interface FlowHandle`

- - ### Constructor Detail

    - #### FlowHandle

          public FlowHandle()

  - ### Method Detail

    - #### getId

          @NotNull
          StateMachineRunId getId()

      The started state machine's ID.

    - #### getReturnValue

          @NotNull
          CordaFuture<A> getReturnValue()

      A `interface CordaFuture` of the flow's return value.

      See Also:
        `interface CordaFuture`

    - #### close

          void close()

      Use this function for flows whose returnValue is not going to be used, so as to free up server resources.