View Javadoc

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.tklm.api.time.rules.graceperiod;
17  
18  import java.math.BigDecimal;
19  
20  import org.kuali.kpme.core.api.bo.HrBusinessObjectContract;
21  
22  
23  /**
24   * <p>GracePeriodRuleContract interface</p>
25   *
26   */
27  public interface GracePeriodRuleContract extends HrBusinessObjectContract {
28  	
29  	/**
30  	 * The number of minutes that define the Grace Period
31  	 * 
32  	 * <p>
33  	 * hourFactor of a GracePeriodRule
34  	 * <p>
35  	 * 
36  	 * @return hourFactor for GracePeriodRule
37  	 */
38  	public BigDecimal getHourFactor();
39  
40  	/**
41  	 * TODO: Put a better comment
42  	 * The user principal id associated with the GracePeriodRule
43  	 * 
44  	 * <p>
45  	 * userPrincipalId of a GracePeriodRule
46  	 * <p>
47  	 * 
48  	 * @return userPrincipalId for GracePeriodRule
49  	 */
50  	public String getUserPrincipalId();
51  	
52  	/**
53  	 * The primary key of a GracePeriodRule entry saved in a database
54  	 * 
55  	 * <p>
56  	 * tkGracePeriodRuleId of a GracePeriodRule
57  	 * <p>
58  	 * 
59  	 * @return tkGracePeriodRuleId for GracePeriodRule
60  	 */
61  	public String getTkGracePeriodRuleId();
62  
63  	/**
64  	 * TODO: Put a better comment
65  	 * The history flag of the GracePeriodRule
66  	 * 
67  	 * <p>
68  	 * history flag of a GracePeriodRule
69  	 * <p>
70  	 * 
71  	 * @return history for GracePeriodRule
72  	 */
73  	public boolean isHistory();
74  
75  }