Rules

The following rules apply to the AuditMappings class:

The stereotype must be audit_mappings.
The attributes of the class must be valid domain definitions.
The class must be "flat", i.e. it cannot aggregate any other classes.

Audit mappings are made available to an application by adding a class named AuditMappings with a audit_mappings stereotype to the model. Individual entity classes can then enable audit mappings by setting theAudit Fields option.

If the meta-model contains an AuditMappings class then a Java implementation class for it must be provided in the impl package.

Note: If this implementation class is not present, the server application cannot be compiled. In this situation the developer should either:

delete the `AuditMappings` class from the model
explicitly disable audit mappings completely by specifying the generator switch-noauditmappings.

The following rules apply to the AuditMappings implementation class:

it must contain the same fields as defined in the meta-model (i.e. they must have the same name and data type.)
these fields must be public
it need not inherit from any other class
it may optionally contain the following method:
public void set(final boolean isInsert, final boolean isModify)

This is a call back method which is called whenever necessary (i.e. during inserts and modifies) by the data access layer and should be used to populate the fields of the `AuditMappings` class. The two boolean parameters indicate whether the database operation is an insert or modify, respectively.
it may optionally contain a public void method named set which takes no parameters. This method will be called by the data-access layer whenever it needs the fields to be updated. (In fact any public method whose name starts with set and which takes no parameters will be called in arbitrary order, but it is not recommended to use multiple setter methods and support for doing so will be discontinued in future.)

If the details struct contains any of the audit mapping fields, then these are updated in the struct automatically during the operation and are included in the update or insert.

For audit mapping fields, which are not present in the details struct, the corresponding field will still be updated on the database, i.e. it is not necessary to include the audit mapping fields in the details struct to get them updated on the database. Note however that such fields are not included in table level auditing.