1   /*
    2   * JBoss, Home of Professional Open Source
    3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4   * by the @authors tag. See the copyright.txt in the distribution for a
    5   * full listing of individual contributors.
    6   *
    7   * This is free software; you can redistribute it and/or modify it
    8   * under the terms of the GNU Lesser General Public License as
    9   * published by the Free Software Foundation; either version 2.1 of
   10   * the License, or (at your option) any later version.
   11   *
   12   * This software is distributed in the hope that it will be useful,
   13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15   * Lesser General Public License for more details.
   16   *
   17   * You should have received a copy of the GNU Lesser General Public
   18   * License along with this software; if not, write to the Free
   19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21   */
   22   package javax.enterprise.deploy.spi.status;
   23   
   24   import javax.enterprise.deploy.shared.ActionType;
   25   import javax.enterprise.deploy.shared.CommandType;
   26   import javax.enterprise.deploy.shared.StateType;
   27   
   28   /**
   29    * The status of the deployment.
   30    *
   31    * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
   32    * @version $Revision: 37459 $
   33    */
   34   public interface DeploymentStatus
   35   {
   36      // Constants -----------------------------------------------------
   37      
   38      // Public --------------------------------------------------------
   39      
   40      /**
   41       * Get the state of the deployment
   42       *
   43       * @return the state
   44       */
   45      StateType getState();
   46      
   47      /**
   48       * The deployment command
   49       *
   50       * @return the command
   51       */
   52      CommandType getCommand();
   53      
   54      /**
   55       * The action of this deployment
   56       *
   57       * @return the action
   58       */
   59      ActionType getAction();
   60      
   61      /**
   62       * Get the message
   63       *
   64       * @return the message
   65       */
   66      String getMessage();
   67      
   68      /**
   69       * Is the deployment complete
   70       *
   71       * @return true when complete, false otherwise
   72       */
   73      boolean isCompleted();
   74      
   75      /**
   76       * Has the deployment failed
   77       *
   78       * @return true when failed, false otherwise
   79       */
   80      boolean isFailed();
   81      
   82      /**
   83       * Is the deployment in progress
   84       *
   85       * @return true when in progress, false otherwise
   86       */
   87      boolean isRunning();
   88   }