/**
 * <copyright> Copyright 2006 by Know-Center, Graz, Austria </copyright>
 * 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.framework.signator;

import java.util.List;

import at.gv.egiz.pdfas.api.analyze.NonTextObjectInfo;
import at.knowcenter.wag.egov.egiz.pdf.ActualTablePos;
import at.knowcenter.wag.egov.egiz.sig.SignatureData;
import at.knowcenter.wag.egov.egiz.sig.connectors.bku.SignSignatureObject;

/**
 * Encapsulates the Signator dependant information that needs to be passed from
 * prepareSign to finishSign.
 * 
 * <p>
 * This supersedes the IncrementalUpdateInformation.
 * </p>
 * 
 * @author wprinz
 */
public interface SignatorInformation
{
  /**
   * Returns the SignatureData to be signed.
   * <p>
   * This is passed on to the Connector and signature device for signing.
   * </p>
   * 
   * @return Returns the SignatureData to be signed.
   */
  public SignatureData getSignatureData();

  /**
   * Sets the SignSignatureObject with the signature data.
   * 
   * <p>
   * This is called by the framework to provide the finishSign with the
   * signature data.
   * </p>
   * 
   * @param signSignatureObject
   *          The SignSignatureObject.
   */
  public void setSignSignatureObject(SignSignatureObject signSignatureObject);

  /**
   * Returns the SignSignatureObject.
   * 
   * <p>
   * After signation, this is used by the framework/API to get additional
   * information about the signature.
   * </p>
   * 
   * @return Returns the SignSignatureObject.
   */
  public SignSignatureObject getSignSignatureObject();

  /**
   * Returns the position where the signature table was actually placed.
   * 
   * @return Returns the position where the signature table was actually placed.
   */
  public ActualTablePos getActualTablePos();
  
  /**
   * Returns a list<{@link NonTextObjectInfo} of non textual objects in the pdf document.
   * Only available for textual signatures. Show this to the user who signed the textual content only! 
   * @return  List<{@link NonTextObjectInfo} or <tt>null</tt> of not available (binary signature)
   */
  public List getNonTextualObjects();
  
  /**
   * Set a list<{@link NonTextObjectInfo} of non textual objects in the pdf document.
   * Only available for textual signatures. Show this to the user who signed the textual content only! 
   */
  public void setNonTextualObjects(List nonTextObjects);
}