| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| InactivateableFromTo |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2007-2008 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.krad.bo; | |
| 17 | ||
| 18 | import java.sql.Timestamp; | |
| 19 | ||
| 20 | /** | |
| 21 | * Business objects that have effective dating (from to dates) should implement this interface. This | |
| 22 | * translates the effective dates in terms of active/inactive status so the features built for | |
| 23 | * {@link Inactivateable} in the frameworks can be taken advantage of | |
| 24 | */ | |
| 25 | public interface InactivateableFromTo extends Inactivateable { | |
| 26 | ||
| 27 | /** | |
| 28 | * Sets the date for which record will be active | |
| 29 | * | |
| 30 | * @param from | |
| 31 | * - Timestamp value to set | |
| 32 | */ | |
| 33 | public void setActiveFromDate(Timestamp from); | |
| 34 | ||
| 35 | /** | |
| 36 | * Gets the date for which the record become active | |
| 37 | * | |
| 38 | * @return Timestamp | |
| 39 | */ | |
| 40 | public Timestamp getActiveFromDate(); | |
| 41 | ||
| 42 | /** | |
| 43 | * Sets the date for which record will be active to | |
| 44 | * | |
| 45 | * @param from | |
| 46 | * - Timestamp value to set | |
| 47 | */ | |
| 48 | public void setActiveToDate(Timestamp to); | |
| 49 | ||
| 50 | /** | |
| 51 | * Gets the date for which the record become inactive | |
| 52 | * | |
| 53 | * @return Timestamp | |
| 54 | */ | |
| 55 | public Timestamp getActiveToDate(); | |
| 56 | ||
| 57 | /** | |
| 58 | * Gets the date for which the record is being compared to in determining active/inactive | |
| 59 | * | |
| 60 | * @return Timestamp | |
| 61 | */ | |
| 62 | public Timestamp getActiveAsOfDate(); | |
| 63 | ||
| 64 | /** | |
| 65 | * Sets the date for which the record should be compared to in determining active/inactive, if | |
| 66 | * not set then the current date will be used | |
| 67 | * | |
| 68 | * @param activeAsOfDate | |
| 69 | * - Timestamp value to set | |
| 70 | */ | |
| 71 | public void setActiveAsOfDate(Timestamp activeAsOfDate); | |
| 72 | ||
| 73 | } |