javax.enterprise.concurrent.LastExecution Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.enterprise.concurrent-api Show documentation
JSR 236:Concurrency Utilities for Java EE
There is a newer version: 1.1
Show newest version
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package javax.enterprise.concurrent;

import java.util.Date;

/**
 * Contains information about the last execution of a task. This is used by
 * the methods in the {@code Trigger} class to determine the next scheduled timeout
 * or whether a run should be skipped.
 *
 * @since 1.0
 */
public interface LastExecution {
    
  /**
   * The name or ID of the identifiable object, as specified in the
   * {@link ManagedTask#IDENTITY_NAME} execution property of the task if
   * it also implements the {@code ManagedTask} interface.
   * 
   * @return the name or ID of the identifiable object.
   */
  public String getIdentityName();

  /**
    * Result of the last execution.
    * 
    * @return The result of the last execution. It could return null if
    *         the last execution did not complete, or the result of the task
    *         was null.
    */
   public Object getResult();

   /**
    * The last time in which task was scheduled to run.
    * 
    * @return The last date/time in which the task was scheduled to run.
    */
   public Date getScheduledStart();

   /** 
    * The last time in which the task started running. 
    * 
    * @return the last date/time in which the task started running, or 
    *         null if the task was canceled before it was started.
    */
   public Date getRunStart();

   /** 
    * The last time in which the task was completed. 
    * 
    * @return the last date/time in which the task was completed, or 
    *         null if the task was canceled before it was completed.
    */
   public Date getRunEnd();
}