View Javadoc

1   /*
2    * Copyright 2005-2008 The Kuali Foundation
3    * 
4    * 
5    * Licensed under the Educational Community License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    * 
9    * http://www.opensource.org/licenses/ecl2.php
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.kuali.rice.kew.plugin;
18  
19  /**
20   * An interface representing an Entity that can be reloaded.  Calls to reload should only be executed if
21   * this Reloadable has flagged itself as reloadable according to the isReloadable() method.
22   * 
23   * <p>If invocations of isReloadable() return false then calls to reload() should be
24   * no-ops.
25   * 
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public interface Reloadable {
29  
30  	/**
31  	 * Indicates whether or not this Reloadable currently supports being reloaded.
32  	 * If this method returns false then calls to reload() are effectively no-ops.
33  	 * 
34  	 * @return true if this Reloadable can be reloaded, false otherwise
35  	 */
36      public boolean isReloadable();
37  
38      public boolean isReloadNeeded();
39      
40      /**
41       * Reloads the Reloadable.  If isReloadable() returns false then this method
42       * should be a no-op.
43       */
44      public void reload() throws Exception;
45      
46  }