com.arjuna.wst11.BAParticipantManager Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a full listing
* of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* 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,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
/*
* Copyright (C) 2003,
*
* Arjuna Technologies Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
* UK.
*
* $Id: BAParticipantManager.java,v 1.5 2004/09/09 08:48:33 kconner Exp $
*/
package com.arjuna.wst11;
import com.arjuna.wst.WrongStateException;
import com.arjuna.wst.UnknownTransactionException;
import com.arjuna.wst.SystemException;
import javax.xml.namespace.QName;
/**
* When a Business Activity participant registers with a BA transaction it
* gets a reference to the transaction coordinator that lets it callback
* into the transaction and drive the state-transition.
*
* One instance of this per transaction.
*
* @author Mark Little ([email protected])
* @version $Id: BAParticipantManager.java,v 1.5 2004/09/09 08:48:33 kconner Exp $
* @since XTS 1.0.
*/
public interface BAParticipantManager
{
/**
* The participant has exited the business activity. The participant
* uses this to inform the coordinator that is has left the activity.
* It will not be informed when (and how) the business activity terminates.
*/
public void exit () throws WrongStateException, UnknownTransactionException, SystemException;
/**
* The participant has completed it works, but wishes to continue in
* the business activity, so that it will eventually be told when (and how)
* the activity terminates. The participant may later be asked to
* compensate for the work it has done.
*/
public void completed () throws WrongStateException, UnknownTransactionException, SystemException;
/**
* Cannot complete.
*/
public void cannotComplete () throws WrongStateException, UnknownTransactionException, SystemException;
/**
* Fault.
*/
public void fail (final QName exceptionIdentifier) throws SystemException;
}