/**
 * 
 */
package at.gv.egiz.pdfas.api.commons;

import java.util.Set;

/**
 * Definition of a signature profile.
 * 
 * @author wprinz
 */
public interface SignatureProfile
{
  // TODO: the full profile information will be implemented in future

  /**
   * Returns the profile id.
   * 
   * @return Returns the profile id.
   */
  public String getProfileId();

  /**
   * Returns the MOA KeyIdentifier.
   * 
   * @return Returns the MOA KeyIdentifier.
   */
  public String getMOAKeyIdentifier();

  // start - modified by tknall
  
  /**
   * Returns the value of a field with a given key for the current profile.
   * <p>
   * e.g.<br/><code>signaturProfile.getField(SignatureTypes.SIG_ISSUER)</code><br/>
   * returns <code>"Issuer-Certificate"</code>
   * </p>
   * <code>null</code> is returned if a field with key <code>key</code>
   * could not be found.
   * 
   * @param key
   *           The key for the field to be returned or <code>null</code> if
   *           there is not such field.
   * @return The value of the field with key <code>key</key>.
   * @see at.knowcenter.wag.egov.egiz.sig.SignatureTypes
   */
  public String getField(String key);

  // added by tknall

  /**
   * Returns a set containing all field keys (properties starting with
   * <code>sig_obj.CURRENT_PROFILE.key.</code> of the current profiles. The
   * set should be unmodifiable.
   */
  public Set getFieldKeys();
  
  // stop - modified by tknall

}