ProcessorAlarm.java

/*
 jBilling - The Enterprise Open Source Billing System
 Copyright (C) 2003-2011 Enterprise jBilling Software Ltd. and Emiliano Conde

 This file is part of jbilling.

 jbilling 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.

 jbilling 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 jbilling.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.sapienter.jbilling.server.pluggableTask;

/**
 * Alarm for notification of payment processor fail/unavailable
 * payment results.
 * @author Lucas Pickstone
 */
public interface ProcessorAlarm {
    /**
     * Initialize before fail, unavailable or successful is called.
     * @param processorName The payment processor used.
     * @param entityId The entity (company) id of the payment.
     */
    public void init(String processorName, Integer entityId);

    /**
     * Payment processed, but failed/declined.
     */
    public void fail();

    /**
     * Processor was unavailable.
     */
    public void unavailable();

    /**
     * Payment processed and successful.
     */
    public void successful();
}