THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Attribute Name | Required? | Description |
|---|---|---|
| entity-name | Y | The name of the entity to clear cache lines of. |
| map-name | Y | The name of a map in the method environment that will be used for the entity fields. If the fields in the map form the full primary key the entry will be removed from the byPrimaryKey cache. If the map exists but the fields do not include a full primary key the entry will be removed from the byAnd cache. If no map-name is specified the entry will be removed from the all cache. |
clear-entity-caches
This is a very simple tag that should be used sparingly because of the performance impact. It clears all lines from all Entity Engine caches. It has no attributes or sub-elements.
set-pk-fields
Looks for each PK field in the named map and if it exists there it will copy it into the named value object.
| Attribute Name | Required? | Description |
|---|---|---|
| value-name | Y | The name of the method environment field that contains the GenericValue object. |
| map-name | Y | The name of a map in the method environment that will be used for the entity fields. |
| set-if-null | N | Specifies whether or not to set fields that are null or empty. Defaults to true. |
set-nonpk-fields
Looks for each non-PK field in the named map and if it exists there it will copy it into the named value object.
| Attribute Name | Required? | Description |
|---|---|---|
| value-name | Y | The name of the method environment field that contains the GenericValue object. |
| map-name | Y | The name of a map in the method environment that will be used for the entity fields. |
| set-if-null | N | Specifies whether or not to set fields that are null or empty. Defaults to true. |
Entity Engine List Operations
store-list
The store-list tag uses the delegator to store all entity values in the list. This is different than storing a single value in that values in the list will be inserted if it does not exist or updated if it does exist.
| Attribute Name | Required? | Description |
|---|---|---|
| list-name | Y | The name of the method environment field that contains the list of GenericValue objects. |
remove-list
The remove-list tag uses the delegator to remove all entity values in the list. For each value in the list if it is a primary key just that entity instance will be removed, but if it is not a full primary key all entity instances will be removed from the datasource that match the constraint of the field map.
| Attribute Name | Required? | Description |
|---|---|---|
| list-name | Y | The name of the method environment field that contains the list of GenericValue objects. |
Entity Engine Transaction Operations
transaction-begin
The transaction-begin tag will begin a transaction if one is not already in place. If a transaction is begun the environment field named as the began-transaction-name will be set to true, otherwise it will be set to false.
Note that unless the simple-method is flagged to not use a transaction all simple-methods will be inside a transaction. The same is true for service calls through the Service Engine.
| Attribute Name | Required? | Description |
|---|---|---|
| began-transaction-name | N | The name of the method environment field that contains a Boolean specifying whether or not a transaction was begun in the current transaction demarcation. Defaults to "beganTransaction". |
transaction-commit
The transaction-commit tag will commit a transaction if a transaction was begun in the current demarcation context as represented by the environment field named as the began-transaction-name. If the Boolean in that field is false no commit will be done.
| Attribute Name | Required? | Description |
|---|---|---|
| began-transaction-name | N | The name of the method environment field that contains a Boolean specifying whether or not a transaction was begun in the current transaction demarcation. Defaults to "beganTransaction". |
transaction-rollback
The transaction-rollback tag will rollback a transaction if a transaction was begun in the current demarcation context as represented by the environment field named as the began-transaction-name. If the Boolean in that field is false a set rollback only will operation will be done instead of rollback which will force the transaction to rollback regardless of which method or object is responsible for beginning and ending the transaction.