/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.mobicents.protocols.ss7.map.api;

import org.mobicents.protocols.ss7.tcap.asn.comp.Problem;
import org.mobicents.protocols.ss7.map.api.dialog.MAPProviderError;
import org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage;


/**
 * 
 * @author amit bhayani
 * 
 */
public interface MAPServiceListener {
	/**
	 * Invoked when TC-U-ERROR primitive is received from the other peer
	 * 
	 * @param mapDialog
	 * @param invokeId
	 * @param mapErrorMessage
	 */
	public void onErrorComponent(MAPDialog mapDialog, Long invokeId, MAPErrorMessage mapErrorMessage);

	/**
	 * Invoked when the provider error when parsing the response
	 * 
	 * @param mapDialog
	 * @param invokeId
	 * @param providerError
	 */
	public void onProviderErrorComponent(MAPDialog mapDialog, Long invokeId, MAPProviderError providerError);

	/**
	 * Invoked when TC-U-REJECT primitive is received from the other peer
	 * @param mapDialog
	 * @param invokeId
	 *            This parameter is optional and may be the null
	 * @param problem
	 */
	public void onRejectComponent(MAPDialog mapDialog, Long invokeId, Problem problem);

	/**
	 * Invoked when no answer from the other peer for a long time - for sending
	 * the a reject for the Invoke
	 * 
	 * @param mapDialog
	 * @param invokeId
	 */
	public void onInvokeTimeout(MAPDialog mapDialog, Long invokeId);

	/**
	 * Called when any MAPMessage received (Invoke, ReturnResult, ReturnResultLast components)
	 * This component will be invoked before the special service component 
	 * 
	 * @param mapDialog
	 */
	public void onMAPMessage(MAPMessage mapMessage);

}