Difference between revisions of "Document Template Classes"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 50: Line 50:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
public void procesData(TemplateContext context, String object,String record)
public void procesData(TemplateContext context, String object,String record)
{
    HashMap<String, Object> productSupplierMap = new HashMap<String, Object>();
    map.put("supplierName", "Stuff R' Us");
    map.put("phone", "408-555-0987");
    context.put("ProductSupplier", productSupplierMap);
}
</syntaxhighlight>


HashMap<String, Object> productSupplierMap = new HashMap<String, Object>();
After that method has run, the Print Template can use the variable <tt>$ProductSupplier.phone</tt>, just as though the data had originated in the platform.
map.put("supplierName", "Stuff R' Us");
map.put("phone", "408-555-0987");
context.put("ProductSupplier", productSupplierMap);
</syntaxhighlight>

Revision as of 21:37, 5 April 2012

This page is currently in progress...

About Print Template Classes

You can use a method in a Print Template Class to manipulate the data that a Print Template has available for processing. Here's how it works:

  • When a Print Template is processed, it gets its data from the TemplateContext
  • That object contains a HashMap for each kind of record that , a data object is simply a HashMap in the . The TemplateContext object is passed to a method in your data-handler so, 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: TemplateContext.get("objectName");
  • Add or update a data object: TemplateContext.put("objectName", HashMap);
  • Get a field from data object: HashMap.get("fieldName");
  • Add or update a field in a data object: HashMap.put("fieldName",value);
    where value is typically a string or a nested HashMap.

The keys for the standard HashMaps that a TemplateContext contains are:

  • createdUsr - The User object for the person who created the record.
  • modifiedUsr - The User object for the person who most recently modified the record.

__TBD: What are the other standard objects?__

Configuring a Print Template to use a Specified Class and Method

--select the class, and the method to use

Methods that take following arguments are listed:

  • com.platform.api.TemplateContext - 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: TemplateContext is in new javadocs, yes? objectName is passed in, yes? Does return value have to be void?__

Accessing Lookup Target Records

__TBD: Is nested data stored like this?__ Data from lookup-target records is stored as a nested map. For example, to get data for the template variable $Order.customer.name:

  1. HashMap orderMap = TemplateContext.get("Order")
    gets the Order HashMap from the context.
  2. HashMap customerMap = orderMap.get("customer")
    gets the lookup-target record for the customer field.
  3. String name = customerMap.get("name")
    gets the customer's name.

Examples

Changing Field Data

Example: Adding a New Field

Example: Adding a New Object

This code creates a new ProductSupplier "object" (as far as the Print Template is concerned), and adds it to the TenantContext (context).

public void procesData(TemplateContext context, String object,String record)
{
    HashMap<String, Object> productSupplierMap = new HashMap<String, Object>();
    map.put("supplierName", "Stuff R' Us");
    map.put("phone", "408-555-0987");
    context.put("ProductSupplier", productSupplierMap);
}

After that method has run, the Print Template can use the variable $ProductSupplier.phone, just as though the data had originated in the platform.