net.corda.flows / AbstractStateReplacementFlow / Instigator

# Instigator

`abstract class Instigator<out S : ContractState, T> : FlowLogic<StateAndRef<S>>`

### Types

NOTARY | `object NOTARY : Step`
SIGNING | `object SIGNING : Step`

### Constructors

<init> | `Instigator(originalState: StateAndRef<S>, modification: T, progressTracker: ProgressTracker = tracker())`

### Properties

modification | `val modification: T`
originalState | `val originalState: StateAndRef<S>`
progressTracker | `open val progressTracker: ProgressTracker` Override this to provide a ProgressTracker. If one is provided and stepped, the framework will do something helpful with the progress reports. If this flow is invoked as a sub-flow of another, then the tracker will be made a child of the current step in the parent. If its null, this flow doesnt track progress.

### Inherited Properties

fsm | `lateinit var fsm: FlowStateMachine<*>` Reference to the Fiber instance that is the top level controller for the entire flow.
logger | `val logger: <ERROR CLASS>` This is where you should log things to.
serviceHub | `val serviceHub: ServiceHub` Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts. It is only available once the flow has started, which means it cannnot be accessed in the constructor. Either access this lazily or from inside call.

### Functions

assembleProposal | `abstract fun assembleProposal(stateRef: StateRef, modification: T, stx: SignedTransaction): Proposal<T>`
assembleTx | `abstract fun assembleTx(): <ERROR CLASS><SignedTransaction, List<CompositeKey>>`
call | `open fun call(): StateAndRef<S>` This is where you fill out your business logic.

### Inherited Functions

getCounterpartyMarker | `open fun getCounterpartyMarker(party: Party): Class<*>` Return the marker Class which party has used to register the counterparty flow that is to execute on the other side. The default implementation returns the class object of this FlowLogic, but any Class instance will do as long as the other side registers with it.
receive | `fun <T : Any> receive(otherParty: Party): UntrustworthyData<T>` `fun <T : Any> receive(otherParty: Party, receiveType: Class<T>): UntrustworthyData<T>`
send | `fun send(otherParty: Party, payload: Any): Unit`
sendAndReceive | `fun <T : Any> sendAndReceive(otherParty: Party, payload: Any, receiveType: Class<T>): UntrustworthyData<T>` `fun <T : Any> sendAndReceive(otherParty: Party, payload: Any): UntrustworthyData<T>`
subFlow | `fun <R> subFlow(subLogic: FlowLogic<R>, shareParentSessions: Boolean = false): R` Invokes the given subflow by simply passing through this FlowLogics reference to the FlowStateMachine and then calling the call method.
track | `fun track(): <ERROR CLASS><String, <ERROR CLASS><String>>?`

### Companion Object Functions

tracker | `fun tracker(): ProgressTracker`

### Inheritors

Instigator | `class Instigator<T : ContractState> : Instigator<T, Party>`