/*******************************************************************************
* Copyright 2014 by E-Government Innovation Center EGIZ, Graz, Austria
* PDF-AS has been contracted by the E-Government Innovation Center EGIZ, a
* joint initiative of the Federal Chancellery Austria and Graz University of
* Technology.
*
* Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
* the European Commission - subsequent versions of the EUPL (the "Licence");
* You may not use this work except in compliance with the Licence.
* You may obtain a copy of the Licence at:
* http://www.osor.eu/eupl/
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the Licence is distributed on an "AS IS" basis,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the Licence for the specific language governing permissions and
* limitations under the Licence.
*
* This product combines work with different licenses. See the "NOTICE" text
* file for details on the various modules and licenses.
* The "NOTICE" text file is part of the distribution. Any derivative works
* that you distribute must include a readable copy of the "NOTICE" text file.
******************************************************************************/
package at.gv.egiz.pdfas.lib.api.sign;
import java.io.OutputStream;
import at.gv.egiz.pdfas.lib.api.PdfAsParameter;
public interface SignParameter extends PdfAsParameter {
/**
* Gets the signature profile to use
* @return
*/
public String getSignatureProfileId();
/**
* Sets the signature profile to use
*
* @param signatureProfileId The signature profile
*/
public void setSignatureProfileId(String signatureProfileId);
/**
* Gets the signature position
* @return
*/
public String getSignaturePosition();
/**
* Sets the signature position
* @param signaturePosition The signature position string
*/
public void setSignaturePosition(String signaturePosition);
/**
* Get Id of a placeholder that should be used for positioning.
*
* @return Id of a placeholder
*/
String getPlaceHolderId();
/**
* Set Id of a placeholder that should be used for positioning.
*
* @param id Id of a placeholder
*/
void setPlaceHolderId(String id);
/**
* Is QR-Code placeholder search enabled for this request.
*
* @return true
if it's enabled, otherwise false
*/
boolean isPlaceHolderSearchEnabled();
/**
* Enable / disable QR-Code placeholder search on request level.
*
*
Default value is true
*
* @param flag true
to enable, false
to disable
*/
void setPlaceHolderSearchEnabled(boolean flag);
/**
* Sets the signer to use
*
*
* @param signer
*/
public void setPlainSigner(IPlainSigner signer);
/**
* Gets the signer to use.
* @return
*/
public IPlainSigner getPlainSigner();
/**
* Gets the outputstream, where the signed document will be written to
* @return
*/
public OutputStream getSignatureResult();
}