/**
 * <copyright> Copyright (c) 2006 by Know-Center, Graz, Austria </copyright>
 * 
 * This software is the confidential and proprietary information of Know-Center,
 * Graz, Austria. You shall not disclose such Confidential Information and shall
 * use it only in accordance with the terms of the license agreement you entered
 * into with Know-Center.
 * 
 * KNOW-CENTER MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. KNOW-CENTER SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
 * LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES.
 * 
 * $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;
  }

}