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