Author: jonesde
Date: Thu Apr 3 15:09:47 2008 New Revision: 644530 URL: http://svn.apache.org/viewvc?rev=644530&view=rev Log: Changed to use description tags instead of comments for oagis entities Modified: ofbiz/trunk/specialpurpose/oagis/entitydef/entitymodel.xml Modified: ofbiz/trunk/specialpurpose/oagis/entitydef/entitymodel.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/oagis/entitydef/entitymodel.xml?rev=644530&r1=644529&r2=644530&view=diff ============================================================================== --- ofbiz/trunk/specialpurpose/oagis/entitydef/entitymodel.xml (original) +++ ofbiz/trunk/specialpurpose/oagis/entitydef/entitymodel.xml Thu Apr 3 15:09:47 2008 @@ -41,24 +41,25 @@ <!-- ========================================================= --> <entity entity-name="OagisMessageInfo" package-name="org.ofbiz.specialpurpose.oagis" title="OAGIS Message Info Entity"> - <field name="logicalId" type="very-short"><!-- CNTROLAREA -> SENDER -> LOGICALID; max 10 chars --></field> - <field name="component" type="very-short"><!-- CNTROLAREA -> SENDER -> COMPONENT; max 10 chars --></field> - <field name="task" type="short-varchar"><!-- CNTROLAREA -> SENDER -> TASK; max 10 chars; note that using short-varchar instead of very-short so we can have longer fields in the DB --></field> + <field name="logicalId" type="very-short"><description>CNTROLAREA -> SENDER -> LOGICALID; max 10 chars</description></field> + <field name="component" type="very-short"><description>CNTROLAREA -> SENDER -> COMPONENT; max 10 chars</description></field> + <field name="task" type="short-varchar"><description>CNTROLAREA -> SENDER -> TASK; max 10 chars; note that using short-varchar instead of very-short so we can have longer fields in the DB</description></field> <field name="referenceId" type="id-long-ne"> - <!-- CNTROLAREA -> SENDER -> REFERENCEID; max 40 chars in spec; for messages sent from OFBiz this will be a + <description>CNTROLAREA -> SENDER -> REFERENCEID; max 40 chars in spec; for messages sent from OFBiz this will be a sequenced ID and be unique on its own; for messages from other systems this may only be unique relative - to the logicalId, component, and task as defined in the OAGIS specifications --> + to the logicalId, component, and task as defined in the OAGIS specifications + </description> </field> - <field name="authId" type="id-long"><!-- CNTROLAREA -> SENDER -> AUTHID; max 50 chars in spec --></field> - <field name="outgoingMessage" type="indicator"><!-- Y for outgoing, N for incoming --></field> - <field name="sentDate" type="date-time"><!-- should be the same as the CNTROLAREA -> DATETIMEISO (DATETIMEANY) element --></field> - <field name="receivedDate" type="date-time"><!-- will generally only be set for outgoing messages --></field> + <field name="authId" type="id-long"><description>CNTROLAREA -> SENDER -> AUTHID; max 50 chars in spec</description></field> + <field name="outgoingMessage" type="indicator"><description>Y for outgoing, N for incoming</description></field> + <field name="sentDate" type="date-time"><description>should be the same as the CNTROLAREA -> DATETIMEISO (DATETIMEANY) element</description></field> + <field name="receivedDate" type="date-time"><description>will generally only be set for outgoing messages</description></field> <field name="confirmation" type="id"> - <!-- + <description> 0 = No confirmation Business Object Document requested 1 = Send back a confirmation Business Object Document only if an error has occurred 2 = Send a confirmation Business Object Document regardless - --> + </description> </field> <field name="bsrVerb" type="short-varchar"></field> <field name="bsrNoun" type="short-varchar"></field> @@ -94,7 +95,7 @@ <field name="component" type="very-short"></field> <field name="task" type="short-varchar"></field> <field name="referenceId" type="id-long-ne"></field> - <field name="errorSeqId" type="id"><!-- this is a secondary sequenced ID relative to the primary key of OagisMessageInfo --></field> + <field name="errorSeqId" type="id"><description>this is a secondary sequenced ID relative to the primary key of OagisMessageInfo</description></field> <field name="reasonCode" type="short-varchar"></field> <field name="description" type="very-long"></field> <prim-key field="logicalId"/> |
Free forum by Nabble | Edit this page |