001    /**
002     * Copyright 2004-2014 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kpme.pm.api.position.funding;
017    
018    import org.kuali.kpme.core.api.bo.HrBusinessObjectContract;
019    
020    import java.math.BigDecimal;
021    
022    /**
023     * <p>PositionFundingContract interface</p>
024     *
025     */
026    public interface PositionFundingContract extends HrBusinessObjectContract {
027    
028        /**
029         * The primary key for a PositionFunding entry saved in the database
030         *
031         * <p>
032         * pmPositionFunctionId of a PositionFunding.
033         * <p>
034         *
035         * @return pmPositionFunctionId for PositionFunding
036         */
037            public String getPmPositionFunctionId();
038    
039        /**
040         * The HR position id associated with the PositionFunding
041         *
042         * <p>
043         * hrPositionId of a PositionFunding.
044         * <p>
045         *
046         * @return hrPositionId for PositionFunding
047         */
048            public String getHrPositionId();
049    
050        /**
051         * The source associated with the PositionFunding
052         *
053         * <p>
054         * source of a PositionFunding.
055         * <p>
056         *
057         * @return source for PositionFunding
058         */
059            public String getSource();
060    
061        /**
062         * The chart associated with the PositionFunding
063         *
064         * <p>
065         * chart of a PositionFunding.
066         * <p>
067         *
068         * @return chart for PositionFunding
069         */
070            public String getChart();
071    
072        /**
073         * The organization associated with the PositionFunding
074         *
075         * <p>
076         * org of a PositionFunding.
077         * <p>
078         *
079         * @return org for PositionFunding
080         */
081            public String getOrg();
082    
083        /**
084         * The account associated with the PositionFunding
085         *
086         * <p>
087         * The account component of the chart of accounts to be charged when time recorded against this work area and task
088         * <p>
089         *
090         * @return account for PositionFunding
091         */
092            public String getAccount();
093    
094        /**
095         * The subAccount associated with the PositionFunding
096         *
097         * <p>
098         * The sub-account component of the chart of accounts to be charged when time recorded against this work area and task
099         * <p>
100         *
101         * @return subAccount for PositionFunding
102         */
103            public String getSubAccount();
104    
105        /**
106         * The object code associated with the PositionFunding
107         *
108         * <p>
109         * The Object code component of the chart of accounts to be charged when time recorded against this work area and task.
110         * <p>
111         *
112         * @return objectCode for PositionFunding
113         */
114            public String getObjectCode();
115    
116        /**
117         * The subObjectCode associated with the PositionFunding
118         *
119         * <p>
120         * The sub-object component of the chart of accounts to be charged when time recorded against this work area and task.
121         * <p>
122         *
123         * @return subObjectCode for PositionFunding
124         */
125            public String getSubObjectCode();
126    
127        /**
128         * The organization reference code associated with the PositionFunding
129         *
130         * <p>
131         * orgRefCode of a PositionFunding.
132         * <p>
133         *
134         * @return orgRefCode for PositionFunding
135         */
136            public String getOrgRefCode();
137    
138        /**
139         * The Percentage that the account will be used to fund the position
140         *
141         * <p>
142         * percent of a PositionFunding.
143         * <p>
144         *
145         * @return percent for PositionFunding
146         */
147            public BigDecimal getPercent();
148    
149        /**
150         * The amount to be funded
151         *
152         * <p>
153         * amount of a PositionFunding.
154         * <p>
155         *
156         * @return amount for PositionFunding
157         */
158            public BigDecimal getAmount();
159    
160        /**
161         * The flag used to indicate account priority
162         *
163         * <p>
164         * priorityFlag of a PositionFunding.
165         * <p>
166         *
167         * @return priorityFlag for PositionFunding
168         */
169            public boolean isPriorityFlag();
170            
171    }