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.pm.api.position.funding;
17
18 import org.kuali.kpme.pm.api.position.PositionDerivedContract;
19 import java.math.BigDecimal;
20
21 /**
22 * <p>PositionFundingContract interface</p>
23 *
24 */
25 public interface PositionFundingContract extends PositionDerivedContract {
26
27 /**
28 * The primary key for a PositionFunding entry saved in the database
29 *
30 * <p>
31 * pmPositionFunctionId of a PositionFunding.
32 * <p>
33 *
34 * @return pmPositionFunctionId for PositionFunding
35 */
36 public String getPmPositionFunctionId();
37
38
39 /**
40 * The source associated with the PositionFunding
41 *
42 * <p>
43 * source of a PositionFunding.
44 * <p>
45 *
46 * @return source for PositionFunding
47 */
48 public String getSource();
49
50 /**
51 * The chart associated with the PositionFunding
52 *
53 * <p>
54 * chart of a PositionFunding.
55 * <p>
56 *
57 * @return chart for PositionFunding
58 */
59 public String getChart();
60
61 /**
62 * The organization associated with the PositionFunding
63 *
64 * <p>
65 * org of a PositionFunding.
66 * <p>
67 *
68 * @return org for PositionFunding
69 */
70 public String getOrg();
71
72 /**
73 * The account associated with the PositionFunding
74 *
75 * <p>
76 * The account component of the chart of accounts to be charged when time recorded against this work area and task
77 * <p>
78 *
79 * @return account for PositionFunding
80 */
81 public String getAccount();
82
83 /**
84 * The subAccount associated with the PositionFunding
85 *
86 * <p>
87 * The sub-account component of the chart of accounts to be charged when time recorded against this work area and task
88 * <p>
89 *
90 * @return subAccount for PositionFunding
91 */
92 public String getSubAccount();
93
94 /**
95 * The object code associated with the PositionFunding
96 *
97 * <p>
98 * The Object code component of the chart of accounts to be charged when time recorded against this work area and task.
99 * <p>
100 *
101 * @return objectCode for PositionFunding
102 */
103 public String getObjectCode();
104
105 /**
106 * The subObjectCode associated with the PositionFunding
107 *
108 * <p>
109 * The sub-object component of the chart of accounts to be charged when time recorded against this work area and task.
110 * <p>
111 *
112 * @return subObjectCode for PositionFunding
113 */
114 public String getSubObjectCode();
115
116 /**
117 * The organization reference code associated with the PositionFunding
118 *
119 * <p>
120 * orgRefCode of a PositionFunding.
121 * <p>
122 *
123 * @return orgRefCode for PositionFunding
124 */
125 public String getOrgRefCode();
126
127 /**
128 * The Percentage that the account will be used to fund the position
129 *
130 * <p>
131 * percent of a PositionFunding.
132 * <p>
133 *
134 * @return percent for PositionFunding
135 */
136 public BigDecimal getPercent();
137
138 /**
139 * The amount to be funded
140 *
141 * <p>
142 * amount of a PositionFunding.
143 * <p>
144 *
145 * @return amount for PositionFunding
146 */
147 public BigDecimal getAmount();
148
149 /**
150 * The flag used to indicate account priority
151 *
152 * <p>
153 * priorityFlag of a PositionFunding.
154 * <p>
155 *
156 * @return priorityFlag for PositionFunding
157 */
158 public boolean isPriorityFlag();
159
160 }