setSegmentState

The set segment state request causes the Transaction Server to set or clear the specified state for the segment.

The Transaction Server uses a presentment accessor to set or clear the specified state. This state conditionally flows to the owning batch (ICL). The Transaction Server does this when needed to enforce the condition. A batch (ICL) state is set if, and only if, all of the segments owned by the batch (ICL) have that state set.

The following table shows the fields that are needed to create a set segment state request.
Table 1. setSegmentState Request
Field Description
Message Type The message type text for this message. The strings that can be used for the message type are:
  • AppBridgeConstants.MSGTYPE_SET_SEGMENT_STATE
  • setSegmentState
Using the string that is defined in the AppBridgeConstants interface is the preferred method for setting the message type.
Unit of Work Segment identifier. It is a long value and must be capable of being parsed as a long.
Payload A collection of NameValuePairBean objects whose properties are:
  • The String name of a state field in the segment table.
  • A Boolean indicating whether to set (true) or clear (false) the state.
The Transaction Server attempts to set or clear the state of the specified segment based on the data that is provided. It also attempts to enforce the presentment state condition above.