FpML Issues Tracker
closed
Minor
Always
Architecture
Admin
andrew
Summary
Add to the the Architecture Definition a pattern for distinguishing between Definitions and References.
For example the distinction between the definition of a trade and a tradeId is clear from the element name. "trade" is a definition and "tradeId" is a reference. However for some types this is not consistent, for example asset. The distinction between asset definition and asset reference is not clear from the element name as both are typically called "asset".
NB - I am not arguing for any particular rule, but arguing that whichever rule we have, that it is followed consistently.
Do we make a distinction in the element name? e.g. "trade" versus "tradeId" and "asset" versus "assetId", and "country" versus "countryId". Or do we always make it "asset", "trade", "country"?
Option 1 - Distinguish in the element name and the type name. Option 2 - Do not distinguish in the element name, do distinguish in the type name.
What naming pattern should there be? * trade for the definition * tradeId for a correlating identifier * trade for an internal hreference to a trade or a tradeReference
Notes:
matthew
06/07/07 1:40 pm
It was agreed at the AWG at 2007-06-07 that the proposed convention is:
xyz – for the definition of the concept
xyzId – for an identifier to the concept
xyzReference – for am internal href to the concept
So for example: trade, tradeId, tradeReference.
And an internal reference to a tradeId would be tradeIdReference.
matthew
06/07/07 1:46 pm
It was agreed at the AWG in 2007-06-07 that this would be added to the Architecture Specification.
mgratacos
06/08/07 9:40 pm
This has been added in section 2.2 Naming Conventions of the Architecture Specification.
mgratacos
06/13/07 10:44 am
What did we agree for naming containers of tradeIds for example???
matthew
06/13/07 5:53 pm
We agreed nothing for containers. It is a separate issue.
mgratacos
06/13/07 9:38 pm
This has been added in section 2.2 Naming Conventions of the Architecture Specification and committed to the trunk.