Understanding PeopleCode used to Work with Message Segments

This section discusses:

• Methods used with message segments.

• Properties used with message segments.

Methods Used with Message Segments

The following table lists the PeopleCode methods you can use when you work with message segments.

Method	Class	Description
CreateNextSegment	Message	Designates the end point of one segment and the beginning of a new segment.
DeleteOrphanedSegments	IntBroker	Used to delete segments that might have been orphaned if you were processing message segments using a PeopleSoft Application Engine program that had to be restarted.
DeleteSegment	Message	Deletes a segment.
GetSegment	Message	Gets the segment specified by the passed value. The passed value is the segment number.
UpdateSegment	Message	Use this method to update data within the current segment.

Note:

Use the DeleteSegment and UpdateSegment methods only when storing segments data in memory. These methods do not function when segment data is stored in the database.

Properties Used with Message Segments

The following table lists PeopleCode properties that you can use when you work with message segments.

Property	Class	Description
CurrentSegment	Message	Returns a number, indicating which segment is the current segment.
SegmentsUnOrder	IBInfo	Determines whether to process message segments in order or unordered. This property pertains to asynchronous messages only. The values are: True: Process message segments unordered. False: Process message segments in order. (Default.)
SegmentCount	Message	Returns the total number of segments in a message.
SegmentsByDatabase	Message	Enables you to override where message segment data is stored for a message. The values are: True: Store message segments awaiting processing in the application database. False: Store message segments awaiting processing in memory. (Default.)