Difference between revisions of "Document Template Classes"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 8: | Line 8: | ||
:* Add or update a data object: TenantContext.put(''objectName'') | :* Add or update a data object: TenantContext.put(''objectName'') | ||
:* Get a field from data object: | :* Get a field from data object: | ||
:* Add or update a field in a data object: | :* Add or update a field in a data object: | ||
===Configuring the Print Template to Use the Method=== | ===Configuring the Print Template to Use the Method=== | ||
:--select the class, and the method to use | :--select the class, and the method to use | ||
::* | Methods that take following arguments are listed: | ||
:* [{{DOCHOST}}/javadocs/com/platform/api/TenantContext.html com.platform.api.TenantContext] - The container that the print template gets its data from. | |||
:* String (objectName) - The name of the object the print template was invoked on. | |||
:* String (recordID) - The ID of the record on which it was invoked. | |||
{{TBD|objectName is passed in, yes? Does return value have to be void}} | |||
===Accessing Lookup Target Records=== | |||
Data from lookup-target records is stored as a nested map. So to get data for the template variable <tt>$Order.customer.name</tt>: | |||
# <tt>HashMap orderMap = TenantContext.get("Order")</tt> gets the Order HashMap from the TenantContext. | |||
# <tt>HashMap customerMap = orderMap.get("customer")</tt> gets the lookup-target record for the customer field. | |||
# <tt>String name = customerMap.get("name")</tt> gets the customer's name. | |||
===Examples=== | ===Examples=== | ||
Revision as of 21:14, 5 April 2012
This page is currently in progress...
About Print Template Classes
As far as a Print Template is concerned, a data object is simply a HashMap in the TenantContext. By manipulating the HashMap(s) it contains, you change the data that the Print Template has available for processing.
- Template reference: $objectName.fieldname
- Retrieve a data object: TenantContext.get(objectName)
- Add or update a data object: TenantContext.put(objectName)
- Get a field from data object:
- Add or update a field in a data object:
Configuring the Print Template to Use the Method
- --select the class, and the method to use
Methods that take following arguments are listed:
- com.platform.api.TenantContext - The container that the print template gets its data from.
- String (objectName) - The name of the object the print template was invoked on.
- String (recordID) - The ID of the record on which it was invoked.
__TBD: objectName is passed in, yes? Does return value have to be void__
Accessing Lookup Target Records
Data from lookup-target records is stored as a nested map. So to get data for the template variable $Order.customer.name:
- HashMap orderMap = TenantContext.get("Order") gets the Order HashMap from the TenantContext.
- HashMap customerMap = orderMap.get("customer") gets the lookup-target record for the customer field.
- String name = customerMap.get("name") gets the customer's name.