com.silanis.esl.sdk.service

Class TemplateService

java.lang.Object

com.silanis.esl.sdk.service.TemplateService

public class TemplateService
extends Object

The TemplateService class provides methods to help create templates from packages.

Constructor Summary

Constructors

Constructor and Description
TemplateService(RestClient client, String baseUrl, PackageService packageService)

Method Summary

Modifier and Type	Method and Description
Placeholder	addPlaceholder(PackageId templateId, Placeholder placeholder) Adds a placeholder to the template.
PackageId	createPackageFromTemplate(DocumentPackage documentPackage, PackageId packageId) Deprecated. Please use createPackageFromTemplate( PackageId packageId, DocumentPackage documentPackage ) instead of this method.
PackageId	createPackageFromTemplate(PackageId packageId, DocumentPackage documentPackage) Creates a package based on an existent template.
PackageId	createTemplate(DocumentPackage template) Creates a template.
PackageId	createTemplateFromPackage(PackageId originalPackageId, DocumentPackage delta) Creates a template from package.
PackageId	createTemplateFromPackage(PackageId originalPackageId, String templateName) Creates a template from package.
Placeholder	updatePlaceholder(PackageId templateId, Placeholder placeholder) Update a placeholder.
void	updateTemplate(DocumentPackage template) Update a template.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateService

public TemplateService(RestClient client,
                       String baseUrl,
                       PackageService packageService)

Method Detail

createTemplateFromPackage

public PackageId createTemplateFromPackage(PackageId originalPackageId,
                                           DocumentPackage delta)

Creates a template from package.

Parameters:

originalPackageId - the package ID used as template

delta - the document package to replace in the template

Returns:

the package ID

createTemplateFromPackage

public PackageId createTemplateFromPackage(PackageId originalPackageId,
                                           String templateName)

Creates a template from package.

Parameters:

originalPackageId - the package ID used as template

templateName - the name of new template

Returns:

the package ID

createPackageFromTemplate

@Deprecated
public PackageId createPackageFromTemplate(DocumentPackage documentPackage,
                                                       PackageId packageId)

Deprecated. Please use createPackageFromTemplate( PackageId packageId, DocumentPackage documentPackage ) instead of this method.

createPackageFromTemplate

public PackageId createPackageFromTemplate(PackageId packageId,
                                           DocumentPackage documentPackage)

Creates a package based on an existent template.

Parameters:

packageId - the package ID used as template for the new package

documentPackage - the document package

Returns:

the package ID

createTemplate

public PackageId createTemplate(DocumentPackage template)

Creates a template.

Parameters:

template - the document package

Returns:

the package ID

updateTemplate

public void updateTemplate(DocumentPackage template)

Update a template.

Parameters:

template - the document package

addPlaceholder

public Placeholder addPlaceholder(PackageId templateId,
                                  Placeholder placeholder)
                           throws EslException

Adds a placeholder to the template.

Parameters:

templateId -

placeholder -

Returns:

The role added

Throws:

EslException

updatePlaceholder

public Placeholder updatePlaceholder(PackageId templateId,
                                     Placeholder placeholder)
                              throws EslException

Update a placeholder.

Parameters:

templateId -

placeholder -

Returns:

The role added

Throws:

EslException