01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57196 $
33: */
34: public interface DeploymentStatus {
35: // Constants -----------------------------------------------------
36:
37: // Public --------------------------------------------------------
38:
39: /**
40: * Get the state of the deployment
41: *
42: * @return the state
43: */
44: StateType getState();
45:
46: /**
47: * The deployment command
48: *
49: * @return the command
50: */
51: CommandType getCommand();
52:
53: /**
54: * The action of this deployment
55: *
56: * @return the action
57: */
58: ActionType getAction();
59:
60: /**
61: * Get the message
62: *
63: * @return the message
64: */
65: String getMessage();
66:
67: /**
68: * Is the deployment complete
69: *
70: * @return true when complete, false otherwise
71: */
72: boolean isCompleted();
73:
74: /**
75: * Has the deployment failed
76: *
77: * @return true when failed, false otherwise
78: */
79: boolean isFailed();
80:
81: /**
82: * Is the deployment in progress
83: *
84: * @return true when in progress, false otherwise
85: */
86: boolean isRunning();
87: }
|