001    /**
002     *
003     * Copyright 2003-2004 The Apache Software Foundation
004     *
005     *  Licensed under the Apache License, Version 2.0 (the "License");
006     *  you may not use this file except in compliance with the License.
007     *  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    
018    //
019    // This source code implements specifications defined by the Java
020    // Community Process. In order to remain compliant with the specification
021    // DO NOT add / change / or delete method signatures!
022    //
023    
024    package javax.enterprise.deploy.spi.status;
025    
026    import javax.enterprise.deploy.shared.CommandType;
027    import javax.enterprise.deploy.shared.StateType;
028    import javax.enterprise.deploy.shared.ActionType;
029    
030    /**
031     * The DeploymentStatus interface provides information about the progress of a
032     * deployment action.
033     *
034     * @version $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $
035     */
036    public interface DeploymentStatus {
037        /**
038         * Retrieve the StateType value.
039         *
040         * @return the StateType object
041         */
042        public StateType getState();
043    
044        /**
045         * Retrieve the deployment CommandType of this event.
046         *
047         * @return the CommandType Object
048         */
049        public CommandType getCommand();
050    
051        /**
052         * Retrieve the deployment ActionType for this event.
053         *
054         * @return the ActionType Object
055         */
056        public ActionType getAction();
057    
058        /**
059         * Retrieve any additional information about the status of this event.
060         *
061         * @return message text
062         */
063        public String getMessage();
064    
065        /**
066         * A convience method to report if the operation is in the completed state.
067         *
068         * @return <tt>true</tt> if this command has completed successfully
069         */
070        public boolean isCompleted();
071    
072        /**
073         * A convience method to report if the operation is in the failed state.
074         *
075         * @return <tt>true</tt> if this command has failed
076         */
077        public boolean isFailed();
078    
079        /**
080         * A convience method to report if the operation is in the running state.
081         *
082         * @return <tt>true</tt> if this command is still running
083         */
084        public boolean isRunning();
085    }