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