...
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| sort | title |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| operator | AND |
|---|
| labels | module,model |
|---|
|
...
Default value of attribute "auditable" is "false" and the attribute itself is not mandatory. When it's "true" every entity in the database defined by the model will have standard predefined fields: createdate, updatedate, createuser and updateuser. These fields store information about who and when created and last edited the entity.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml |
|---|
| theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<model name="sampleModel"
auditable="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schema.qcadoo.org/model"
xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
<fields>
// FIELD DEFINITIONS
</fields>
<hooks>
// HOOK DEFINITIONS
</hooks>
// IDENTIFIER
</model>
|
Structure of field definition
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<fieldType options />
|
or
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<fieldType options>
// VALIDATOR DEFINITIONS
</fieldType>
|
Field types
| Insert excerpt |
|---|
| Model Fields |
|---|
| Model Fields |
|---|
| nopanel | trueModel Fields |
|---|
|
Structure of validator definition
Validators are attached to fields.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<validatorType validatorOptions />
|
Validator types
| Insert excerpt |
|---|
| Model Validators |
|---|
| Model Validators |
|---|
| nopanel | trueModel Validators |
|---|
|
Structure of hook definition
You can create custom event hook and attach it to defined model. To do it first you must create custom method (see this link).
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml |
|---|
| theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<hookType hookOptions />
|
...
| Insert excerpt |
|---|
| Model Hooks |
|---|
| Model Hooks |
|---|
| nopanel | trueModel Hooks |
|---|
|
Identifier
Role of entity identifier is to convert entity defined in model to a simple text (see expressions overview). It is used for example when showing operation messages. If "expression" is givet it is used to evaluate identifier, otherwise "number" field will be taken.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme |
|---|
| Eclipse | linenumbers | true |
|---|
|
<identifier expression="#number + ' - ' + #name"/> |
...
These examples definies three simple entities.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<?xml version="1.0" encoding="UTF-8"?>
<model name="product"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schema.qcadoo.org/model"
xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
<fields>
<string name="number" required="true" unique="true">
<validatesLength max="40" />
</string>
<string name="name" required="true" />
<enum name="typeOfMaterial" values="01component,02intermediate,03product,04waste" required="true" />
<string name="ean" />
<dictionary name="category" dictionary="categories" />
<dictionary name="unit" dictionary="units" required="true" />
<string name="batch">
<validatesLength max="255" />
</string>
<string name="lastUsedBatch">
<validatesLength max="255" />
</string>
<boolean name="genealogyBatchReq" />
<hasMany name="substitutes" model="substitute" joinField="product" cascade="delete" copyable="true" />
<hasMany name="technologies" model="technology" joinField="product" />
<hasMany name="orders" model="order" joinField="product" />
<hasMany name="operationProductInComponents" model="operationProductInComponent" joinField="product" />
<hasMany name="operationProductOutComponents" model="operationProductOutComponent" joinField="product" />
<hasMany name="substituteComponents" model="substituteComponent" joinField="product" />
</fields>
<hooks />
<identifier expression="#number + ' - ' + #name"/>
</model> |
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<?xml version="1.0" encoding="UTF-8"?>
<model name="substitute"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schema.qcadoo.org/model"
xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
<fields>
<string name="number" required="true" unique="true">
<validatesLength max="40" />
</string>
<string name="name" required="true" />
<belongsTo name="product" model="product" lazy="false" required="true" />
<hasMany name="components" model="substituteComponent" joinField="substitute" cascade="delete" copyable="true" />
<priority name="priority" scope="product" />
</fields>
<hooks>
<validatesWith class="com.qcadoo.mes.products.ProductService" method="checkIfProductIsNotRemoved" />
</hooks>
<identifier expression="#number + ' - ' + #name" />
</model> |
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | xml | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
<?xml version="1.0" encoding="UTF-8"?>
<model name="substituteComponent"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schema.qcadoo.org/model"
xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
<fields>
<belongsTo name="product" model="product" lookupField="name" required="true" />
<belongsTo name="substitute" model="substitute" required="true" />
<decimal name="quantity" required="true">
<validatesRange from="0" exclusively="true" />
<validatesPrecision max="7" />
<validatesScale max="3" />
</decimal>
</fields>
<hooks>
<validatesWith class="com.qcadoo.mes.products.ProductService" method="checkIfSubstituteIsNotRemoved" />
<validatesWith class="com.qcadoo.mes.products.ProductService" method="checkSubstituteComponentUniqueness" />
</hooks>
<identifier expression="#product['number'] + ' - ' + #product['name']"/>
</model> |