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