com.dynamicpdf.api.DlexInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dynamicpdf-api Show documentation

A Java Client API that uses the DynamicPDF API to create, merge, split, form fill, stamp, secure/encrypt PDF documents.

There is a newer version: 1.10.1

package com.dynamicpdf.api;

/**
 * Represents a Dlex input.
 */

public class DlexInput extends Input {

	private String layoutDataResourceName;

	/**
	 * Initializes a new instance of the DlexInput class by posting the 
	 * DLEX file and the JSON data file from the client to the API to create the PDF report.
	 * @param dlexResource The DlexResource, dlex file created as per the desired PDF report layout design.
	 * @param layoutData The LayoutDataResource, json data file used to create the PDF report.
	 */

	public DlexInput(DlexResource dlexResource, LayoutDataResource layoutData) {
		super();
		setResourceName(dlexResource.getResourceName());
		layoutDataResourceName = layoutData.getLayoutDataResourceName();
		getResources().add(dlexResource);
		getResources().add(layoutData);

	}
	
	/**
	 * Initializes a new instance of the DlexInput class by posting the
	 * DLEX file and the JSON data file from the client to the API to create the PDF report.
	 * @param dlexResource The DlexResource, dlex file created as per the desired PDF report layout design.
	 * @param layoutData The json data string used to create the PDF report.
	 */
	public DlexInput(DlexResource dlexResource, String layoutData) {
		setResourceName(dlexResource.getResourceName());
		LayoutDataResource layoutDataResource = new LayoutDataResource(layoutData);
		layoutDataResourceName = layoutDataResource.getLayoutDataResourceName();
		getResources().add(dlexResource);
		getResources().add(layoutDataResource);
	}

	/**
	 * Initializes a new instance of the DlexInput class by taking the 
	 * DLEX file path that is present in the cloud environment and the JSON data file from the client.
	 * @param cloudResourcePath The DLEX file path present in the resource manager.
	 * @param layoutData The LayoutDataResource, json data file used to create the PDF report.
	 */

	public DlexInput(String cloudResourcePath, LayoutDataResource layoutData) {
		super();
		setResourceName(cloudResourcePath);
		layoutDataResourceName = layoutData.getLayoutDataResourceName();
		getResources().add(layoutData);
	}

	/**
	 * Initializes a new instance of the DlexInput class.
	 * @param cloudResourcePath The DLEX file path present in the resource manager.
	 * @param layoutData The json data string used to create the PDF report.
	 */

	public DlexInput(String cloudResourcePath, String layoutData) {
		super();
		setResourceName(cloudResourcePath);
		LayoutDataResource layoutDataResource = new LayoutDataResource(layoutData);
        layoutDataResourceName = layoutDataResource.getLayoutDataResourceName();
        getResources().add(layoutDataResource);
	}

	InputType getType() {
		return InputType.DLEX;
	}

	/**
	 * Gets the name for layout data resource.
	 * @return The Name of Layout Data Resource 
	 */
	public String getLayoutDataResourceName() {
		return layoutDataResourceName;
	}

	/**
	 * sets the name for layout data resource.
	 * @param value The name for layout data resource.
	 */
	public void setLayoutDataResourceName(String value) {
		layoutDataResourceName = value;
	}
}