KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > enterprise > deploy > spi > status > DeploymentStatus


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package javax.enterprise.deploy.spi.status;
25
26 import javax.enterprise.deploy.shared.StateType JavaDoc;
27 import javax.enterprise.deploy.shared.CommandType JavaDoc;
28 import javax.enterprise.deploy.shared.ActionType JavaDoc;
29
30 /**
31  * The DeploymentStatus interface provides information about
32  * the progress status of a deployment action.
33  */
34 public interface DeploymentStatus
35 {
36    /**
37     * Retrieve the StateType value.
38     *
39     * @return the StateType object
40     */
41    public StateType JavaDoc getState();
42
43    /**
44     * Retrieve the deployment CommandType of this event.
45     *
46     * @return the CommandType Object
47     */
48    public CommandType JavaDoc getCommand();
49
50    /**
51     * Retrieve the deployment ActionType for this event.
52     *
53     * @return the ActionType Object
54     */
55    public ActionType JavaDoc getAction();
56
57    /**
58     * Retrieve any additional information about the
59     * status of this event.
60     *
61     * @return message text
62     */
63    public String JavaDoc getMessage();
64
65    /**
66     * A convience method to report if the operation is
67     * in the completed state.
68     *
69     * @return true if this command has completed successfully
70     */
71    public boolean isCompleted();
72
73    /**
74     * A convience method to report if the operation is
75     * in the failed state.
76     *
77     * @return true if this command has failed
78     */
79    public boolean isFailed();
80
81    /**
82     * A convience method to report if the operation is
83     * in the running state.
84     *
85     * @return true if this command is still running
86     */
87    public boolean isRunning();
88 }
89
Popular Tags