cardagent.java

POS is a Java&#174 platform-based, mission-critical, ISO-8583 based financial transaction library/fr

/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2008 Alejandro P. Revilla
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.jpos.core;

import org.jpos.tpl.PersistentEngine;

/**
 * @author [e-mail]
 * @version $Revision: 2594 $ $Date: 2008-01-22 14:41:31 -0200 (Tue, 22 Jan 2008) $
 * @since jPOS 1.1
 *
 * Implements financial institution specific functionality<br>
 * CardAgent may rely on <b><i>j</i>POS</b>'s ISO package
 * for the low level interchange implementation.
 */
public interface CardAgent {
    /**
     * @return agent unique ID
     */
    public int getID();

    /**
     * @return Configuration instance
     */
    public Configuration getConfiguration();

    /**
     * @param t CardTransaction
     * @return true if agent is able/willing to handle this transaction
     */
    public boolean canHandle (CardTransaction t);

    /**
     * Process the transaction
     * @param t previously promoted CardTransaction
     * @return CardTransactionInfo object associated with this transaction
     * @exception CardAgentException
     */
    public CardTransactionResponse process (CardTransaction t) 
        throws CardAgentException;

    /**
     * @return property prefix used in configuration
     */
    public String getPropertyPrefix();

    /**
     * Set PersistentEngine associated with this CardAgent
     * @param engine a PersistentEngine instance
     */
    public void setPersistentEngine (PersistentEngine engine);

    /**
     * @return PersistentEngine instance
     */
    public PersistentEngine getPersistentEngine ();

}