org.ow2.bonita.services.handlers.FinishedInstanceHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bonita-services Show documentation

The newest version!

/**
 * Copyright (C) 2007  Bull S. A. S.
 * Bull, Rue Jean Jaures, B.P.68, 78340, Les Clayes-sous-Bois
 * This library 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
 * version 2.1 of the License.
 * This library 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
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA  02110-1301, USA.
 **/
package org.ow2.bonita.services.handlers;

import org.ow2.bonita.facade.uuid.ProcessInstanceUUID;

/**
 * Specifies a handler for finished xpdl instances.
 *
 * When an instance is finished, a {@link FinishedInstanceHandler} is taken from the environment,
 * and the method handleFinishedInstance is called.
 *
 * @author Guillaume Porcher
 *
 */
public interface FinishedInstanceHandler {

  String DEFAULT_KEY = "finished-instance-handler";
  /**
   * This method is called when a instance is finished (i.e. one of the execution thread
   * points to the process ending node).
   * @param instance instance that has just finished.
   */
  void handleFinishedInstance(ProcessInstanceUUID instanceUUID);
}