/**
 * <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.
 *
 * $Id: SignatureFieldDefinition.java,v 1.1 2006/08/25 17:09:41 wprinz Exp $
 */
package at.knowcenter.wag.egov.egiz.sig;

import java.io.Serializable;

/**
 * This class contains the information about one field in the signature block.
 * 
 * <p>
 * E.g. Field "Issuer" could have the caption "Aussteller", the value null and
 * the placeholder length of 500.
 * </p>
 * 
 * @author wprinz
 */
public class SignatureFieldDefinition implements Serializable
{

  /**
   * SVUID.
   */
  private static final long serialVersionUID = -46020173047777315L;

  /**
   * The key identifier of this field.
   */
  public String field_name = null;

  /**
   * The static caption of the field.
   */
  public String caption = null;

  /**
   * The static value of the field.
   * 
   * <p>
   * Null means that this field has no static value and must be filled out.
   * </p>
   */
  public String value = null;

  /**
   * If the field is not static and has to be filled out, this gives the
   * length of the placeholder that is reserved for filling out.
   * 
   * <p>
   * This has to be large enough so that it can hold the whole value to be
   * filled out.
   * </p>
   */
  public int placeholder_length = -1;
  
  /**
   * Stores the three byte abbreviation code of this field's field name.
   */
  //public byte [] brev = null;

  public String toString()
  {
    return this.field_name + ": caption=" + this.caption + ", value=" + this.value + ", phlen=" + this.placeholder_length;
  }

}