View Javadoc

1   /**
2    *
3    * Copyright 2003-2004 The Apache Software Foundation
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  //
19  // This source code implements specifications defined by the Java
20  // Community Process. In order to remain compliant with the specification
21  // DO NOT add / change / or delete method signatures!
22  //
23  
24  package javax.enterprise.deploy.spi.status;
25  
26  import javax.enterprise.deploy.shared.CommandType;
27  import javax.enterprise.deploy.shared.StateType;
28  import javax.enterprise.deploy.shared.ActionType;
29  
30  /**
31   * The DeploymentStatus interface provides information about the progress of a
32   * deployment action.
33   *
34   * @version $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $
35   */
36  public interface DeploymentStatus {
37      /**
38       * Retrieve the StateType value.
39       *
40       * @return the StateType object
41       */
42      public StateType getState();
43  
44      /**
45       * Retrieve the deployment CommandType of this event.
46       *
47       * @return the CommandType Object
48       */
49      public CommandType getCommand();
50  
51      /**
52       * Retrieve the deployment ActionType for this event.
53       *
54       * @return the ActionType Object
55       */
56      public ActionType getAction();
57  
58      /**
59       * Retrieve any additional information about the status of this event.
60       *
61       * @return message text
62       */
63      public String getMessage();
64  
65      /**
66       * A convience method to report if the operation is in the completed state.
67       *
68       * @return <tt>true</tt> if this command has completed successfully
69       */
70      public boolean isCompleted();
71  
72      /**
73       * A convience method to report if the operation is in the failed state.
74       *
75       * @return <tt>true</tt> if this command has failed
76       */
77      public boolean isFailed();
78  
79      /**
80       * A convience method to report if the operation is in the running state.
81       *
82       * @return <tt>true</tt> if this command is still running
83       */
84      public boolean isRunning();
85  }