THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
The find-by-primary-key tag uses the delegator to find an entity value by its primary key. The resulting GenericValue object will be placed in the method environment using the specified value-name.
| Attribute Name | Required? | Description |
|---|---|---|
| value-name | Y | The name of the method environment field that contains the GenericValue object. |
| entity-name | Y | The name of the entity to find an instance of. |
| map-name | Y | The name of a map in the method environment that will be used for the entity fields. |
| delegator-name | N | By default this operation is done using the delegator that is part of the simple-method calling context. This allows you to override the default delegator by naming an alternate delegator. |
| use-cache | N | Specifies whether or not the delegator's cache should be searched before going to the database. This results in much faster retrieval times, but can return stale data that is not the most current in the database. Must be "true" or "false", defaults to "false". |
find-by-and
The find-by-and tag uses the delegator to find entity values by anding the fields passed in the map. The resulting GenericValue objects will be placed in the method environment using the specified list-name.
| Attribute Name | Required? | Description |
|---|---|---|
| ist-name | Y | The name of the method environment field that contains the list of GenericValue objects. |
| entity-name | Y | The name of the entity to find instances of. |
| map-name | Y | The name of a map in the method environment that will be used for the entity fields. |
| order-by-list-name | Y | The name of a list in the method environment that contains a list of strings specifying fields to order the results by. |
| delegator-name | N | By default this operation is done using the delegator that is part of the simple-method calling context. This allows you to override the default delegator by naming an alternate delegator. |
| use-cache | N | Specifies whether or not the delegator's cache should be searched before going to the database. This results in much faster retrieval times, but can return stale data that is not the most current in the database. Must be "true" or "false", defaults to "false". |
| use-iterator | N | Specifies whether or not to use the EntityListIterator when doing the query. This is much more efficient for large data sets because the results are read incrementaly instead of all at once. Note that when using this the use-cache setting will be ignored. Also note that an EntityListIterator must be closed when you are finished, but this is done automatically by the iterate operation. Must be "true" or "false", defaults to "false". |
filter-list-by-and
The filter-list-by-and tag filters the given list by the fields in the specified map.
| Attribute Name | Required? | Description |
|---|---|---|
| list-name | Y | The name of the method environment field that contains the list of GenericValue objects. |
| to-list-name | N | The name of the method environment field the filtered list will be put into. Defaults to the value of the list-name attribute (ie goes to the same place it came from, replacing the old list). |
| map-name | N | The name of a map in the method environment that will be used for the entity fields. If no map is used this will just make a copy of the list. |
filter-list-by-date
The filter-list-by-date tag filters the given list by the valid date using the from and thru dates in each value object.
| Attribute Name | Required? | Description |
|---|---|---|
| list-name | Y | The name of the method environment field that contains the list of GenericValue objects. |
| to-list-name | N | The name of the method environment field the filtered list will be put into. Defaults to the value of the list-name attribute (ie goes to the same place it came from, replacing the old list). |
| valid-date-name | N | The name of a field in the method environment date to filter by. Defaults to now. |
| from-field-name | N | The name of the GenericValue field to use as the beginning effective date. Defaults to fromDate. |
| thru-field-name | N | The name of the GenericValue field to use as the ending effective date. Defaults to thruDate. |
| all-same | N | Specifies whether or not all GenericValue objects in the list are of the same entity. Defaults to true. |
Entity Engine Value Operations
make-value
The make-value tag uses the delegator to construct an entity value. The resulting value will not necessarily exist in the database, but will simply be assembled using the entity-name and fields map. The resulting GenericValue object will be placed in the method environment using the specified value-name.
| Attribute Name | Required? | Description |
|---|---|---|
| value-name | Y | The name of the method environment field that contains the GenericValue object. |
| entity-name | Y | The name of the entity to construct an instance of. |
| map-name | N | The name of a map in the method environment that will be used for the entity fields. |