com.silanis.esl.sdk.service

Class LayoutService

java.lang.Object

com.silanis.esl.sdk.service.LayoutService

public class LayoutService
extends Object

The LayoutService class provides methods to help create and apply document layouts.

Constructor Summary

Constructors

Constructor and Description
LayoutService(RestClient restClient, String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	applyLayout(PackageId packageId, String documentId, String layoutId) Apply a document layout to a document in a DocumentPackage.
void	applyLayoutByName(PackageId packageId, String documentId, String layoutName) Apply a document layout to a document in a DocumentPackage.
DocumentPackage	createAndGetLayout(DocumentPackage layout) Create and get a layout from an already created DocumentPackage.
String	createLayout(DocumentPackage layout) Create a document layout from an already created DocumentPackage.
List<DocumentPackage>	getLayouts(Direction direction, PageRequest request) Get a list of layouts (DocumentPackages).

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutService

public LayoutService(RestClient restClient,
                     String baseUrl)

Method Detail

createLayout

public String createLayout(DocumentPackage layout)

Create a document layout from an already created DocumentPackage. Will only save document fields for one document in the package.

Parameters:

layout - the DocumentPackage with one document from which to create layout.

Returns:

The layout id.

createAndGetLayout

public DocumentPackage createAndGetLayout(DocumentPackage layout)

Create and get a layout from an already created DocumentPackage.

Parameters:

layout - the DocumentPackage with one document from which to create layout.

Returns:

DocumentPackage layout.

getLayouts

public List<DocumentPackage> getLayouts(Direction direction,
                                        PageRequest request)

Get a list of layouts (DocumentPackages).

Parameters:

direction - of retrieved list to be sorted in ascending or descending order by name.

request - Identifying which page of results to return.

Returns:

The list of layouts.

applyLayout

public void applyLayout(PackageId packageId,
                        String documentId,
                        String layoutId)

Apply a document layout to a document in a DocumentPackage. Adds fields to signer's signature or if the signer does not exist, will create placeholders.

Parameters:

packageId - The package id of the DocumentPackage to apply layout.

documentId - The document id of the document to apply layout.

layoutId - The layout id of the layout to apply.

applyLayoutByName

public void applyLayoutByName(PackageId packageId,
                              String documentId,
                              String layoutName)

Apply a document layout to a document in a DocumentPackage. Adds fields to signer's signature or if the signer does not exist, will create placeholders.

Parameters:

packageId - The package id of the DocumentPackage to apply layout.

documentId - The document id of the document to apply layout.

layoutName - The layout name of the layout to apply.