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

/**
 * Interface specifying accessors for two attributes needed for returning 
 * <code>HashInputData</code> and <code>ReferenceInputData</code> information
 * as part of <code>VerifyXMLSignatureResponse</code>.
 * 
 * @author Gregor Karlinger
 * 
 * @version $Id$
 */
public interface InputData extends Content
{
  /**
   * Possible value returned by {@link #getPartOf}. 
   */
  public static String CONTAINER_SIGNEDINFO_ = "SignedInfo";

  /**
   * Possible value returned by {@link #getPartOf}. 
   */
  public static String CONTAINER_XMLDSIGMANIFEST_ = "XMLDSIGManifest";
  
  /**
   * Value returned by {link getReferringReferenceNumber}, signalling that the
   * attribute is not used.
   */
  public static int REFERER_NONE_ = -1;
  
  /**
   * Returns a <code>String</code> signalling what kind of container the 
   * XMLDSIG <code>Reference</code> this <code>InputData</code> belongs 
   * to is part of.
   * 
   * @return the kind of container. 
   */
  public String getPartOf();
  
  /**
   * If this <code>InputData</code> belongs to an XMLDSIG <code>Reference</code>
   * being part of either a XMLDSIGManifest or a SignatureManifest, this method
   * returns a positive int value signalling the particular <code>Reference</code>
   * of the XMLDSIG <code>SignedInfo</code> referring to the XMLDSIGManifest or
   * SignatureManifest respectively.
   */
  public int getReferringReferenceNumber();
}