Package org.imixs.workflow.wopi

Class WopiTemplateAdapter

java.lang.Object

org.imixs.workflow.wopi.WopiTemplateAdapter

All Implemented Interfaces:

org.imixs.workflow.Adapter, org.imixs.workflow.SignalAdapter

public class WopiTemplateAdapter
extends Object
implements org.imixs.workflow.SignalAdapter

This adapter class is used to import a office document template from the local file system. The office document can be edited by the Wopi Adapter technology.

The Adapter class can be configured through the model by defining a workflow result tag named 'wopi-template'.

Example:

 

    <wopi-template name="source-path">./my-templates/invoice-template.odt</wopi-template>
       <wopi-template name="target-name">invoice-2020.odt</wopi-template>
 
 

The template can optionally be loaded from a office textblock attachment.

 
      <wopi-template name="source-path"><textblock>invoice template</textblock></office-template>
 
 

In this case the adapter will load the first attachment from the textblock with the name 'inoice template'.

Version:

1.0

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_ERROR
static String	SNAPSHOTID

Constructor Summary

Constructors

Constructor	Description
WopiTemplateAdapter()

Method Summary

Modifier and Type	Method	Description
org.imixs.workflow.ItemCollection	execute(org.imixs.workflow.ItemCollection document, org.imixs.workflow.ItemCollection event)	This method imports a office document template into the current workitem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_ERROR

public static final String API_ERROR

See Also:

Constant Field Values

SNAPSHOTID

public static String SNAPSHOTID

Constructor Detail

WopiTemplateAdapter

public WopiTemplateAdapter()

Method Detail

execute

public org.imixs.workflow.ItemCollection execute(org.imixs.workflow.ItemCollection document,
                                                 org.imixs.workflow.ItemCollection event)
                                          throws org.imixs.workflow.exceptions.AdapterException

This method imports a office document template into the current workitem.

Specified by:

execute in interface org.imixs.workflow.Adapter

Throws:

org.imixs.workflow.exceptions.AdapterException