Update beans

Update beans are used to apply updates to higher-order entities, such as transmissions and batches (ICLs), in the Transaction Server.

The entities are identified by using their table-specific ID values. The supported types of update beans are shown in the following table.
Table 1. Update bean types
Update bean Class name of the bean Description
Outbound transmission update bean PresentmentGroupUpdateBean Used to update certain fields in an outbound transmission. The outbound transmission must exist for the bean to work.
Batch (ICL) update bean PresentmentUpdateBean Used to update certain fields in a batch (ICL). The batch (ICL) must exist for the bean to work.
Segment update bean SegmentUpdateBean Used to update certain fields in a segment. The segment must exist for the bean to work.
TCH participant status update bean TchPartnerUpdateBean Used to update the status for a TCH participant.

The Transaction Server receives the information for the requested update in the applyUpdates message. It turns on an action code that determines how to handle the update that it received. The unit of work is ignored for all of the update beans.

The following table shows the message content for the applyUpdates request for an update bean.
Table 2. applyUpdates Request
Field Description
Message Type The message type text for this message. The strings that can be used for the message type are shown in the following list.
  • AppBridgeConstants.MSGTYPE_APPLY_UPDATES
  • applyUpdates
Using the string that is defined in the AppBridgeConstants interface is the preferred method for setting the message type.
Unit of Work Not used
Payload Any update bean with a type that is shown in the following list.
  • PresentmentGroupUpdateBean
  • PresentmentUpdateBean
  • SegmentUpdateBean
  • TchPartnerUpdateBean

Each update bean contains an entity ID and a set of name and value pairs that describe the entity fields to modify.
Contents If you don't want to use the payload field to send the information that is needed for this applyUpdates request, you can send it in this field instead. Use a <contents> element to contain the XML with the information that is needed for the request.
Note: The name and value pairs in a bean are not meant for general use by an external application. Each update bean provides individual setters to specify the entity parameters that can be modified. Do not try to directly reference the name and value pair maps in an update bean.
Each update bean returns an update code when requested. The code indicates the type of update to be done. The Transaction Server supports the following update codes.
  • public static final short UPDATE_PRESENTMENT_GROUP = 2;
  • public static final short UPDATE_PRESENTMENT = 3;
  • public static final short UPDATE_SEGMENT = 4;

The following sections describe the update beans that do the updates that are associated with these update codes.