1 /**
2 * Copyright 2004-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.kpme.core.api.bo;
17
18 import java.sql.Timestamp;
19 import java.util.Date;
20
21 import org.joda.time.LocalDate;
22 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
23 import org.kuali.rice.krad.bo.PersistableBusinessObject;
24 /**
25 * <p>HrBusinessObjectContract interface.</p>
26 *
27 */
28 public interface HrBusinessObjectContract extends PersistableBusinessObject, Inactivatable{
29
30 /**
31 * The unique id defined by the object, could be a combination
32 * of multiple fields
33 *
34 * <p>
35 * id of HrBusinessObject
36 * <p>
37 *
38 * @return id of HrBusinessObject
39 */
40 public abstract String getId();
41
42 /**
43 * The effective date of the HrBusinessObject
44 *
45 * <p>
46 * effectiveDate of HrBusinessObject
47 * <p>
48 *
49 * @return effectiveDate of HrBusinessObject
50 */
51 public Date getEffectiveDate();
52
53 /**
54 * The localDate format of the effective date of the HrBusinessObject
55 *
56 * <p>
57 * effectiveLocalDate of HrBusinessObject
58 * <p>
59 *
60 * @return effectiveLocalDate of HrBusinessObject
61 */
62 public LocalDate getEffectiveLocalDate();
63
64 /**
65 * Relative effective date of HrBusinessObject. Returns effectiveDate if not null, current date otherwise.
66 *
67 * <p>
68 * effectiveDate of HrBusinessObject, or current date if null
69 * </p>
70 *
71 * @return effectiveDate of HrBusinessObject, or current date if null
72 */
73 public Date getRelativeEffectiveDate();
74
75 /**
76 * The timestamp of when this HrBusinessObject was last created/updated
77 *
78 * <p>
79 * timestamp of HrBusinessObject
80 * <p>
81 *
82 * @return timestamp of HrBusinessObject
83 */
84 public Timestamp getTimestamp();
85 }