Documentation Contract Entity

entity/Contract_entity/Contract_entity.aod

@@ -3,6 +3,7 @@
   <name>Contract_entity</name>
   <title>Contract</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Contract_entity/documentation.adoc</documentation>
   <recordContainerType>DB</recordContainerType>
   <caption>Contract</caption>
   <iconId>VAADIN:FORM</iconId>
@@ -11,6 +12,7 @@
   <entityFields>
     <entityField>
       <name>CONTRACTCODE</name>
+      <documentation>%aditoprj%/entity/Contract_entity/entityfields/contractcode/documentation.adoc</documentation>
       <title>Contract number</title>
       <tableName>CONTRACT</tableName>
       <columnName>CONTRACTCODE</columnName>
@@ -19,6 +21,7 @@
     </entityField>
     <entityField>
       <name>CONTRACTDUE</name>
+      <documentation>%aditoprj%/entity/Contract_entity/entityfields/contractdue/documentation.adoc</documentation>
       <title>Next due date</title>
       <tableName>CONTRACT</tableName>
       <columnName>CONTRACTDUE</columnName>
@@ -29,6 +32,7 @@
     </entityField>
     <entityField>
       <name>CONTRACTEND</name>
+      <documentation>%aditoprj%/entity/Contract_entity/entityfields/contractend/documentation.adoc</documentation>
       <title>Contract expiry date</title>
       <tableName>CONTRACT</tableName>
       <columnName>CONTRACTEND</columnName>
@@ -46,6 +50,7 @@
     </entityField>
     <entityField>
       <name>CONTRACTSTART</name>
+      <documentation>%aditoprj%/entity/Contract_entity/entityfields/contractstart/documentation.adoc</documentation>
       <title>Contract start date</title>
       <tableName>CONTRACT</tableName>
       <columnName>CONTRACTSTART</columnName>
@@ -98,6 +103,7 @@
     </entityField>
     <entityField>
       <name>RELATION_ID</name>
+      <documentation>%aditoprj%/entity/Contract_entity/entityfields/relation_id/documentation.adoc</documentation>
       <title>Contact / Company</title>
       <tableName>CONTRACT</tableName>
       <columnName>RELATION_ID</columnName>
@@ -165,6 +171,7 @@
     <entityFieldGroup>
       <name>CONTRACTCODE_DISPLAY_fieldGroup</name>
       <valueProcess>%aditoprj%/entity/Contract_entity/entityfields/contractcode_display_fieldgroup/valueProcess.js</valueProcess>
+      <documentation>%aditoprj%/entity/Contract_entity/entityfields/contractcode_display_fieldgroup/documentation.adoc</documentation>
       <description>FIELDGROUP</description>
       <fields>
         <element>CONTRACTTYPE</element>

entity/Contract_entity/documentation.adoc

+= Contract_entity
+:hardbreaks:
+
+Entity contains meta data of the Contract module.
+It provides data from database table CONTRACT.
\ No newline at end of file

entity/Contract_entity/entityfields/contractcode/documentation.adoc

+= CONTRACTCODE
+:hardbreaks:
+
+Unique identification number of the contract. (max. 30 characters, not automatically generated)
\ No newline at end of file

entity/Contract_entity/entityfields/contractcode_display_fieldgroup/documentation.adoc

+= CONTRACTCODE_DISPLAY_fieldGroup
+:hardbreak:
+
+This field appears in the preview view of the contract.
+
+It concatenates the type of contract and the contract code.
\ No newline at end of file

entity/Contract_entity/entityfields/contractdue/documentation.adoc

+= CONTRACTDUE
+:hardbreaks:
+
+Indicates the next due date of the payment. 
+
+== onValidation
+
+Value of field _CONTRACTDUE_ has to be
+
+* >= value of field _CONTRACTSTART_
+* \<= value of field _CONTRACTEND_
\ No newline at end of file

entity/Contract_entity/entityfields/contractend/documentation.adoc

+= CONTRACTEND
+:hardbreaks:
+
+Indicates the contract expiry date.
+
+== onValidation
+
+Value of field _CONTRACTEND_ has to be
+
+* >= value of field _CONTRACTSTART_
+
+== onValueChange
+
+Value of field _CONTRACTDUE_ is set to value of _CONTRACTEND_ if the following conditions are true:
+
+* _CONTRACTDUE_ > _CONTRACTEND_
+* _CONTRACTDUE_ has already been set
\ No newline at end of file

entity/Contract_entity/entityfields/contractstart/documentation.adoc

+= CONTRACTSTART
+:hardbreaks:
+
+Indicates the contract start date.
+
+== onValidation
+
+Value of field _CONTRACTSTART_ has to be
+
+* \<= value of field _CONTRACTEND_
+
+== onValueChange
+
+Value of field _CONTRACTDUE_ is set to value of _CONTRACTSTART_ if the following conditions are true:
+
+* _CONTRACTDUE_ < _CONTRACTSTART_
+* _CONTRACTDUE_ has already been set
\ No newline at end of file

entity/Contract_entity/entityfields/relation_id/documentation.adoc

+= RELATION_ID
+:hardbreaks:
+
+Indicates the contract partner. 
+This can be an organisation or a contact person.
\ No newline at end of file