TRANSFER Reference Manual

ALTER-FOLDER-DESCR
TISERV UOW Descriptions
069139, Update 1 to 40969 Tandem Computers Incorporated 2–73
ALTER-FOLDER-DESCR Operation
ALTER-FOLDER-DESCR can update ordering criteria and item retention time for a
specified folder. Field values in this UOW indicate the new ordering criteria and item
retention time.
Folder order affects the sequence in which items are saved and subsequently
referenced. Each item saved in a folder has an associated ordering key. The ordering
key can be information associated with the item, such as the name of the item's creator
or information provided by the TRANSFER application. Every folder is ordered by
the value of the ordering key associated with each item stored in the folder.
The INBOX, WASTEBASKET, and OUTLOG cannot have APPLIC-DEFINED (A)
ordering discipline. An attempt to use APPLIC-DEFINED ordering for these folders
returns the error E-SPECIAL-FLD. These special folders must allow duplicates: if you
set ALLOW-DUPLICATES to N, the error E-SPECIAL-FLD is returned.
SCAN-FOLDER, SCAN-FOLDER-B00, and SCAN-FOLDER-BY-KEY UOWs retrieve
item IDs in ordering key sequence. The SCAN-FOLDER-BY-KEY UOW, however, is
restricted to folders with an APPLIC-DEFINED ordering discipline. GET-FOLDER-
DESCR retrieves both the ordering criteria and the default item retention time for a
folder.
A folder must be empty before you can alter the ordering criteria. If an ALTER-
FOLDER-DESCR UOW is issued for a folder that contains items, TISERV returns the
error E-ITEMS-IN-FLD. You can change the item retention time without emptying the
folder, as long as the ordering criteria remain unchanged. A change to the default
item retention time for a folder does not affect the retention times of items already in
the folder.