ProcedureExecution.java

/*******************************************************************************
 * Copyright 2015 Software Evolution and Architecture Lab, University of Zurich
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package eu.cloudwave.wp5.common.model;

/**
 * A {@link ProcedureExecution} represents the execution of a {@link Procedure} at one point in time.
 */
public interface ProcedureExecution {

  /**
   * Returns the {@link Procedure} of the current {@link ProcedureExecution}.
   * 
   * @return the {@link Procedure} of the current {@link ProcedureExecution}
   */
  public Procedure getProcedure();

  /**
   * Returns the start time of the {@link ProcedureExecution} in milliseconds.
   * 
   * @return the start time of the {@link ProcedureExecution} in milliseconds
   */
  public long getStartTime();

  /**
   * Sets the {@link ProcedureExecution} that called the current {@link ProcedureExecution}.
   * 
   * @param caller
   *          the {@link ProcedureExecution} that called the current {@link ProcedureExecution}
   */
  public void setCaller(ProcedureExecution caller);

  /**
   * Returns the {@link ProcedureExecution} that called the current {@link ProcedureExecution}.
   * 
   * @return the {@link ProcedureExecution} that called the current {@link ProcedureExecution}
   */
  public ProcedureExecution getCaller();

}