| Name: | ADDRESS_DATA |
| Component: | core |
| Derived From: | SVR_STRING<2048> |
| Options: | LEADING: yes
TRAILING: yes |
| Description: | Stores an address together with its layout type. Format is as follows:
- (line 1) <widgetVersion> (version of widget which created the address - used to determine whether the current widget is capable of displaying the address and to allow changes to the format described here along with backward compatibility)
- (line 2) <addressID> (the key to the Address entity)
- (line 3) <addressLayoutType>
- (line 4) <countryCode> (code table code)
- (line 5) <modifiableInd> (flag indicating whether the address may be modified - cloned addresses are not modifiable)
- (line 6) <versionNo> (optimistic lock)
- (line 7 and following) <other address data>
where <other address data>depends on <addressLayoutType>:
- <addressLayoutType>=FREEFORM:
- <other address data> is plain text with each line delimited by the standard line termination character
- <addressLayoutType>=anything else:
- <other address data> is a list of <name>=<value> pairs, each delimited by the standard line termination character.
Note that:
- the <name>=<value> pairing assumes that each <value> cannot itself contain a line termination character;
- the order of <name>=<value> lines is irrelevant;
- the list of <name> tags expected for a given <addressLayoutType> will be validated by the server application code and the client address widget; and
- some of the data included in lines 1-6 is also stored as attributes on the entity. This duplication allows searches on these fields (without having to parse addressData) whilst enabling this field to contain the complete information required by the client in order to display the address in the address widget.
|
