setPresentmentState

The set batch (ICL) state request causes the Transaction Server to set or clear the specified state for the batch (ICL). The Transaction Server uses a presentment accessor to set or clear the specified state.

The following table shows the fields that are needed to create a set batch (ICL) state request.
Table 1. setPresentmentState 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_PRESENTMENT_STATE
  • setPresentmentState
Using the string that is defined in the AppBridgeConstants interface is the preferred method for setting the message type.
Unit of Work Batch (ICL) 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:
  • A String name of a state field in the presentment 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 batch (ICL) based on the data that is provided. It also attempts to set this state in all of the segments that are owned by the specified batch (ICL). It does not attempt to clear the state in the segments or batches (ICLs) that are owned.

When setting the state of an inbound batch (ICL), the state is also set for all of the processing batches (ICLs) and segments that are owned by the specified batch (ICL). The state for a parent, or owning, entity is also updated when all of its children have reached the same state. For example, if a state is set or cleared for a processing batch (ICL) such that all of the processing batches (ICLs) that are owned by an inbound batch (ICL) are now in the same state, that state is set or cleared for the inbound batch (ICL) as well.