package at.gv.egovernment.moa.spss.api.xmlverify;

import java.util.Date;
import java.util.List;


/**
 * Object that encapsulates a request to verify an XML signature.
 * 
 * @author Patrick Peck
 * @author Stephan Grill
 * @version $Id$
 */
public interface VerifyXMLSignatureRequest {
  /**
   * Gets the date and time for which the signature verification has to
   * be performed.
   * 
   * @return Date and time for which the signature verification has
   * to be performed.
   */
  public Date getDateTime();
  /**
   * Gets the signature to be verified.
   * 
   * @return The signature to be verified.
   */
  public VerifySignatureInfo getSignatureInfo();
  /**
   * Gets the supplemental information.
   * 
   * @return The supplemental information.
   */  
  public List getSupplementProfiles();
  /**
   * Gets parameters for Security Layer signature verification.
   * 
   * @return Parameters for Security Layer signature verification.
   */
  public SignatureManifestCheckParams getSignatureManifestCheckParams();
  /**
   * Checks, whether actually signed data shall be returned.
   * 
   * @return <code>true</code>, if signed data will be returned,
   * otherwise <code>false</code>.
   */
  public boolean getReturnHashInputData();
  /**
   * Gets the profile id of the set of trusted certificates to be used for
   * signature verification.
   * 
   * @return The id of the trusted certificates.
   */
  public String getTrustProfileId();
}