org.ow2.bonita.facade.runtime.ActivityBody Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006  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.facade.runtime;

import java.io.Serializable;
import java.util.Date;
import java.util.List;

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

/**
 * Runtime (recorded) data concerning activities is divided in a common part and a body.

 * This interface concerns the body of the activity.

 * It provides three common methods for the four interfaces dedicated for body of activity

 * (getting ActivityBodyUUID, started and ended date).
 *
 */
public interface ActivityBody extends Serializable {

  /**
   * Return the UUID of the ActivityBody.

   * For instance, if the body of the activity is a TaskInstance this UUID is a TaskUUID.
   * @return The UUID of the ActivityBody.
   */
  ActivityBodyUUID getUUID();

  ActivityBody copy();

  /**
   * Returns the date recorded after the activity is started.
   * @return The date recorded after the activity is started.
   */
  Date getStartedDate();

  /**
   * Returns the date recorded after the activity is finished.
   * @return The date recorded after the activity is finished.
   */
  Date getEndedDate();

  /**
   * Returns the date recorded when the activ.
   * @return The date recorded when the activity becomes READY.
   */
  Date getReadyDate();

  /**
   * Returns the current state.
   * @return The current state.
   */
  ActivityState getState();


  /**
   * Returns the list of recorded {@link StateUpdate state changes}.
   * @return The list of recorded {@link StateUpdate state changes}.
   */
  List getStateUpdates();

}