Modify Record class

The modify record class contains the methods that are needed to update a record before it is written to a file. The UserModifyRecordImpl class implements the UserModifyRecord interface. It provides the setter methods that are required by the interface and their corresponding getter methods. When the UserModifyRecordImpl class is extended, the following methods must be implemented:
  • modifyRecord() - This method is called for every nonaddenda record that is being written to the file. It receives the record to modify in an ICLRecord object. modifyRecord uses getRecordType method from the ICLRecord object to determine the type of record that is being passed.
The UserModifyRecordImpl class also provides access to the following information:
  • Configuration information that was used to construct the record. This information is available for all record types. The data includes the information that is shown in the following list.
    • Bank
    • Building options
    • Channel definition
    • Endpoint
    • Transmission definition
    • Participant
  • Information from database tables. These objects are used only for retrieving data, and should not be modified. The objects include the ones that are shown in the following list.
    • OutboundSegment - for data from the OUTBOUND_SEGMENT table.
    • OutboundPresentment - for data from the OUTBOUND_PRESENTMENT table.
    • OutboundPresentmentGroup - for data from the OUTBOUND_PRES_GROUP table.

A complete description of these classes and methods can be found in the Javadoc information, which is in the install_directory/shared/v409/pfs/Distribution/sdk/doc/JavaDoc directory.

Addenda methods

For record types that have addenda or image addenda, such as type 25 or 31 item records, the UserModifyRecordImpl class provides the following methods:
  • getItemAddenda() - This method returns a vector that contains the current addenda records in the order that they are to be written to the file. Addenda records can be added, deleted, and modified. Also, some addenda records have a numerical sequence indicator within the record data. When addenda records are added or deleted, the administrator is responsible for keeping the addenda in the proper order and updating the sequence number.
  • getImageAddenda() - This method returns a UserImageAddenda object. The UserImageAddenda object has methods for getting and setting the type 50, 52, and 54 records for all four image views: FBW, RBW, FGS, and RGS.
  • getOriginalItem() - This method returns a UserItemInterface object for the original item that was stored in the FTM database. The UserItemInterface has methods for retrieving the data from the original item, including the original record data.

A complete description of these classes and methods can be found in the Javadoc information, which is in the install_directory/shared/v409/pfs/Distribution/sdk/doc/JavaDoc directory.