Features

Fill-in a single template with a value object

/** <p>Fills the given single file template specified by its name and return the filled document
* in the templates format.</p>
* <p>The template file format has to be in the configured template provider - @see TemplateServiceConfiguration</p>
* @param templateName the template file name
* @param dto the value object to fill the template
* @param <T> the value object type
* @throws TemplateServiceException if invalid parameters caught
* @throws TemplateProcessException thrown if the configuration/call params are invalid
* @return ResultDocument a copy of the input template filled with the dto's data on success
*
* */
  <T> ResultDocument fill(final String templateName, final T dto) throws TemplateServiceException;

Fill a template resulting a given format

/** Fills the given single file template specified by its name and converts if needed to the given output format.
* @param templateName The template file name
* @param dto the value object to fill the template
* @param format the output format - @see OutputFormat
* @param <T> the value object type
* @throws TemplateServiceException if invalid parameters caught
* @throws TemplateProcessException thrown if the configuration/call params are invalid
* @return ResultDocument a copy of the input template filled with the dto's data on success
*
* */
  <T> ResultDocument fill(final String templateName, final T dto, final OutputFormat format)
  throws TemplateServiceException;

Process a document structure

/** Process a multipart template (consisting of one or more template files) and return one or more result documents.
* @param documentStructure the document structure to be filled with the specified values.
* @param values the value objects for the document parts. The values are organized into contexts where
*               each document part may have its own value objects and a global one - see the template contexts
*               in @see ValueSet.
* @throws TemplateServiceException if invalid parameters caught
* @return GenerationResult the result documents generated based on the input documentstructure and value set
* */
  GenerationResult fill(final DocumentStructure documentStructure, final ValueSet values)
  throws TemplateServiceException;

Process a document structure by its friendly name

/** Process a multipart template (consisting of one or more template files) and return one or more result documents.
* @param documentStructureFile the document structure file name to be filled with the specified values.
* @param values the value objects for the document parts. The values are organized into contexts where
*               each document part may have its own value objects and a global one - see the template contexts
*               in @see ValueSet.
* @throws TemplateServiceException if invalid parameters caught
* @return GenerationResult the result documents generated based on the input documentstructure and value set
* */
  GenerationResult fillDocumentStructureByName(final String documentStructureFile, final ValueSet values)
  throws TemplateServiceException;

Fill and store a template

/** <p>Fills the given single file template specified by its name and return the filled document
* in the templates format.</p>
* <p>The template file format has to be in the configured template provider - @see TemplateServiceConfiguration</p>
* @param templateName the template file name
* @param dto the value object to fill the template
* @param <T> the value object type
* @throws TemplateServiceException if invalid parameters caught
* @throws TemplateProcessException thrown if the configuration/call params are invalid
* @return StoredResultDocument the result filename and its save success flag
*
* */
  <T> StoredResultDocument fillAndSave(final String templateName, final T dto) throws TemplateServiceException;

Fill and store a template in a given format

/** Fills the given single file template specified by its name and converts if needed to the given output format.
* @param templateName The template file name
* @param dto the value object to fill the template
* @param format the output format - @see OutputFormat
* @param <T> the value object type
* @throws TemplateServiceException if invalid parameters caught
* @throws TemplateProcessException thrown if the configuration/call params are invalid
* @return StoredResultDocument the result filename and its save success flag
*
* */
  <T> StoredResultDocument fillAndSave(final String templateName, final T dto, final OutputFormat format)
  throws TemplateServiceException;

Fill and store a document structure

/** Process a multipart template (consisting of one or more template files) and return one or more result documents.
* @param documentStructure the document structure to be filled with the specified values.
* @param values the value objects for the document parts. The values are organized into contexts where
*               each document part may have its own value objects and a global one - see the template contexts
*               in @see ValueSet.
* @throws TemplateServiceException if invalid parameters caught
* @return StoredGenerationResult the result documents file names generated based on the input documentstructure and
*         value set
* */
  StoredGenerationResult fillAndSave(final DocumentStructure documentStructure, final ValueSet values)
  throws TemplateServiceException;

Fill and save a document structure by its friendly name

/** Process a multipart template (consisting of one or more template files) and return one or more result documents.
* @param documentStructureFile the document structure file name to be filled with the specified values.
* @param values the value objects for the document parts. The values are organized into contexts where
*               each document part may have its own value objects and a global one - see the template contexts
*               in @see ValueSet.
* @throws TemplateServiceException if invalid parameters caught
* @return GenerationResult the result documents generated based on the input documentstructure and value set
* */
  StoredGenerationResult fillAndSaveDocumentStructureByName(final String documentStructureFile, final ValueSet values)
  throws TemplateServiceException;