Constructor Detail

• FlowStartContext

  FlowStartContext()

  Default constructor.

• FlowStartContext

  FlowStartContext(FlowKey statusKey, FlowInitiatorType initiatorType, String requestId, HoldingIdentity identity, String cpiId, HoldingIdentity initiatedBy, String flowClassName, String startArgs, KeyValuePairList contextPlatformProperties, Instant createdTimestamp)

  All-args constructor.

  Parameters:

  statusKey - The unique ID for tracking the flow status

  initiatorType - The type of initiator that started the flow

  requestId - The request ID assigned by the client or session that created the flow.

  identity - The identity of the party executing the flow.

  cpiId - The CPI ID for the package containing the flow.

  initiatedBy - The identity of the party that initiated the flow.

  flowClassName - The fully qualified class name of the flow.

  startArgs - The body of the request provided when the flow was started if this flow was started via RPC.

  contextPlatformProperties - A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context.

  createdTimestamp - The date and time the flow was created.

Method Detail

• getStatusKey

   FlowKey getStatusKey()

  Gets the value of the 'statusKey' field.

• setStatusKey

   void setStatusKey(FlowKey value)

  Sets the value of the 'statusKey' field. The unique ID for tracking the flow status

  Parameters:

  value - the value to set.

• getInitiatorType

   FlowInitiatorType getInitiatorType()

  Gets the value of the 'initiatorType' field.

• setInitiatorType

   void setInitiatorType(FlowInitiatorType value)

  Sets the value of the 'initiatorType' field. The type of initiator that started the flow

  Parameters:

  value - the value to set.

• getRequestId

   String getRequestId()

  Gets the value of the 'requestId' field.

• setRequestId

   void setRequestId(String value)

  Sets the value of the 'requestId' field. The request ID assigned by the client or session that created the flow.

  Parameters:

  value - the value to set.

• getIdentity

   HoldingIdentity getIdentity()

  Gets the value of the 'identity' field.

• setIdentity

   void setIdentity(HoldingIdentity value)

  Sets the value of the 'identity' field. The identity of the party executing the flow.

  Parameters:

  value - the value to set.

• getCpiId

   String getCpiId()

  Gets the value of the 'cpiId' field.

• setCpiId

   void setCpiId(String value)

  Sets the value of the 'cpiId' field. The CPI ID for the package containing the flow.

  Parameters:

  value - the value to set.

• getInitiatedBy

   HoldingIdentity getInitiatedBy()

  Gets the value of the 'initiatedBy' field.

• setInitiatedBy

   void setInitiatedBy(HoldingIdentity value)

  Sets the value of the 'initiatedBy' field. The identity of the party that initiated the flow.

  Parameters:

  value - the value to set.

• getFlowClassName

   String getFlowClassName()

  Gets the value of the 'flowClassName' field.

• setFlowClassName

   void setFlowClassName(String value)

  Sets the value of the 'flowClassName' field. The fully qualified class name of the flow.

  Parameters:

  value - the value to set.

• getStartArgs

   String getStartArgs()

  Gets the value of the 'startArgs' field.

• setStartArgs

   void setStartArgs(String value)

  Sets the value of the 'startArgs' field. The body of the request provided when the flow was started if this flow was started via RPC. Null otherwise.

  Parameters:

  value - the value to set.

• getContextPlatformProperties

   KeyValuePairList getContextPlatformProperties()

  Gets the value of the 'contextPlatformProperties' field.

• setContextPlatformProperties

   void setContextPlatformProperties(KeyValuePairList value)

  Sets the value of the 'contextPlatformProperties' field. A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

  Parameters:

  value - the value to set.

• getCreatedTimestamp

   Instant getCreatedTimestamp()

  Gets the value of the 'createdTimestamp' field.

• setCreatedTimestamp

   void setCreatedTimestamp(Instant value)

  Sets the value of the 'createdTimestamp' field. The date and time the flow was created.

  Parameters:

  value - the value to set.

• getClassSchema

   static Schema getClassSchema()

• getEncoder

   static BinaryMessageEncoder<FlowStartContext> getEncoder()

  Return the BinaryMessageEncoder instance used by this class.

• getDecoder

   static BinaryMessageDecoder<FlowStartContext> getDecoder()

  Return the BinaryMessageDecoder instance used by this class.

• createDecoder

   static BinaryMessageDecoder<FlowStartContext> createDecoder(SchemaStore resolver)

  Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.

  Parameters:

  resolver - a SchemaStore used to find schemas by fingerprint

• toByteBuffer

   ByteBuffer toByteBuffer()

  Serializes this FlowStartContext to a ByteBuffer.

• fromByteBuffer

   static FlowStartContext fromByteBuffer(ByteBuffer b)

  Deserializes a FlowStartContext from a ByteBuffer.

  Parameters:

  b - a byte buffer holding serialized data for an instance of this class

• getSpecificData

   SpecificData getSpecificData()

• getSchema

   Schema getSchema()

• get

   Object get(int field$)

• getConversion

   Conversion<out Object> getConversion(int field)

• put

   void put(int field$, Object value$)

• newBuilder

   static FlowStartContext.Builder newBuilder()

  Creates a new FlowStartContext RecordBuilder.

• newBuilder

   static FlowStartContext.Builder newBuilder(FlowStartContext.Builder other)

  Creates a new FlowStartContext RecordBuilder by copying an existing Builder.

  Parameters:

  other - The existing builder to copy.

• newBuilder

   static FlowStartContext.Builder newBuilder(FlowStartContext other)

  Creates a new FlowStartContext RecordBuilder by copying an existing FlowStartContext instance.

  Parameters:

  other - The existing instance to copy.

• writeExternal

   void writeExternal(ObjectOutput out)

• readExternal

   void readExternal(ObjectInput in)