Save This Page
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.enterprise.deploy.spi.status;
38
39 import javax.enterprise.deploy.shared.StateType;
40 import javax.enterprise.deploy.shared.CommandType;
41 import javax.enterprise.deploy.shared.ActionType;
42
43 /**
44 * The DeploymentStatus interface provides information about
45 * the progress status of a deployment action.
46 */
47 public interface DeploymentStatus
48 {
49 /**
50 * Retrieve the StateType value.
51 *
52 * @return the StateType object
53 */
54 public StateType getState();
55
56 /**
57 * Retrieve the deployment CommandType of this event.
58 *
59 * @return the CommandType Object
60 */
61 public CommandType getCommand();
62
63 /**
64 * Retrieve the deployment ActionType for this event.
65 *
66 * @return the ActionType Object
67 */
68 public ActionType getAction();
69
70 /**
71 * Retrieve any additional information about the
72 * status of this event.
73 *
74 * @return message text
75 */
76 public String getMessage();
77
78 /**
79 * A convience method to report if the operation is
80 * in the completed state.
81 *
82 * @return true if this command has completed successfully
83 */
84 public boolean isCompleted();
85
86 /**
87 * A convience method to report if the operation is
88 * in the failed state.
89 *
90 * @return true if this command has failed
91 */
92 public boolean isFailed();
93
94 /**
95 * A convience method to report if the operation is
96 * in the running state.
97 *
98 * @return true if this command is still running
99 */
100 public boolean isRunning();
101 }