package at.gv.egovernment.moa.spss.server.config;

/**
 * A class that contains information about a hardware key module.
 * 
 * @author Patrick Peck
 * @version $Id$
 */
public class HardwareKeyModule extends KeyModule {
  /** The name of the module. */
  private String name;
  /** The slod ID of the module. */
  private String slotID;
  /** The user PIN of the module. */
  private String userPIN;
  
  /**
   * Create a new <code>HardwareKey</code>.
   * 
   * @param id The key module ID.
   * @param name The name of the key.
   * @param slotID The slot ID of the key within the hardware module. May be
   * <code>null</code>.
   * @param userPIN The user PIN to access the key.
   */
  public HardwareKeyModule(String id, String name, String slotID, String userPIN) {
    super(id);
    this.name = name;
    this.slotID = slotID;
    this.userPIN = userPIN;   
  }
  
  /**
   * Return the name of this <code>HardwareKey</code>.
   * 
   * @return The name of this <code>HardwareKey</code>.
   */
  public String getName() {
    return name;
  }
  
  /**
   * Return the slot ID of this <code>HardwareKey</code>.
   * 
   * @return The slot ID of this <code>HardwareKey</code>.
   */
  public String getSlotID() {
    return slotID;
  }
  
  /**
   * Return the user PIN to access this <code>HardwareKey</code>.
   * 
   * @return The user PIN to access this <code>HardwareKey</code>.
   */
  public String getUserPIN() {
    return userPIN;
  }
}