/*
 * Copyright 2003 Federal Chancellery Austria
 * MOA-SPSS has been developed in a cooperation between BRZ, the Federal
 * Chancellery Austria - ICT staff unit, 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.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();
  
  /**
   * Should perform extended validation
   * 
   * @return <code>true</code>, if signed data will be returned,
   * otherwise <code>false</code>.
   */
  public boolean getExtendedValidaiton();
}