001 /*
002 * Copyright 2011 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
017 package org.kuali.kfs.fp.businessobject;
018
019 import java.util.LinkedHashMap;
020
021 import org.kuali.kfs.coa.businessobject.Account;
022 import org.kuali.kfs.coa.businessobject.Chart;
023 import org.kuali.kfs.coa.businessobject.ObjectCode;
024 import org.kuali.kfs.sys.businessobject.SystemOptions;
025 import org.kuali.rice.kns.bo.PersistableBusinessObjectBase;
026 import org.kuali.rice.kns.util.KualiDecimal;
027
028 /**
029 * This class is used to represent a Wire Charge business object, which is a method of payment to an institution.
030 */
031 public class WireCharge extends PersistableBusinessObjectBase {
032
033 private Integer universityFiscalYear;
034 private String chartOfAccountsCode;
035 private String accountNumber;
036 private String incomeFinancialObjectCode;
037 private String expenseFinancialObjectCode;
038 private KualiDecimal domesticChargeAmt;
039 private KualiDecimal foreignChargeAmt;
040
041 private SystemOptions fiscalYear;
042 private Chart chartOfAccounts;
043 private ObjectCode incomeFinancialObject;
044 private ObjectCode expenseFinancialObject;
045 private Account account;
046
047 /**
048 * Default no-arg constructor.
049 */
050 public WireCharge() {
051
052 }
053
054 /**
055 * Gets the universityFiscalYear attribute.
056 *
057 * @return Returns the universityFiscalYear
058 */
059 public Integer getUniversityFiscalYear() {
060 return universityFiscalYear;
061 }
062
063
064 /**
065 * Sets the universityFiscalYear attribute.
066 *
067 * @param universityFiscalYear The universityFiscalYear to set.
068 */
069 public void setUniversityFiscalYear(Integer universityFiscalYear) {
070 this.universityFiscalYear = universityFiscalYear;
071 }
072
073 /**
074 * Gets the chartOfAccountsCode attribute.
075 *
076 * @return Returns the chartOfAccountsCode
077 */
078 public String getChartOfAccountsCode() {
079 return chartOfAccountsCode;
080 }
081
082
083 /**
084 * Sets the chartOfAccountsCode attribute.
085 *
086 * @param chartOfAccountsCode The chartOfAccountsCode to set.
087 */
088 public void setChartOfAccountsCode(String chartOfAccountsCode) {
089 this.chartOfAccountsCode = chartOfAccountsCode;
090 }
091
092 /**
093 * Gets the accountNumber attribute.
094 *
095 * @return Returns the accountNumber
096 */
097 public String getAccountNumber() {
098 return accountNumber;
099 }
100
101
102 /**
103 * Sets the accountNumber attribute.
104 *
105 * @param accountNumber The accountNumber to set.
106 */
107 public void setAccountNumber(String accountNumber) {
108 this.accountNumber = accountNumber;
109 }
110
111 /**
112 * Gets the incomeFinancialObjectCode attribute.
113 *
114 * @return Returns the incomeFinancialObjectCode
115 */
116 public String getIncomeFinancialObjectCode() {
117 return incomeFinancialObjectCode;
118 }
119
120
121 /**
122 * Sets the incomeFinancialObjectCode attribute.
123 *
124 * @param incomeFinancialObjectCode The incomeFinancialObjectCode to set.
125 */
126 public void setIncomeFinancialObjectCode(String incomeFinancialObjectCode) {
127 this.incomeFinancialObjectCode = incomeFinancialObjectCode;
128 }
129
130 /**
131 * Gets the expenseFinancialObjectCode attribute.
132 *
133 * @return Returns the expenseFinancialObjectCode
134 */
135 public String getExpenseFinancialObjectCode() {
136 return expenseFinancialObjectCode;
137 }
138
139
140 /**
141 * Sets the expenseFinancialObjectCode attribute.
142 *
143 * @param expenseFinancialObjectCode The expenseFinancialObjectCode to set.
144 */
145 public void setExpenseFinancialObjectCode(String expenseFinancialObjectCode) {
146 this.expenseFinancialObjectCode = expenseFinancialObjectCode;
147 }
148
149 /**
150 * Gets the domesticChargeAmt attribute.
151 *
152 * @return Returns the domesticChargeAmt
153 */
154 public KualiDecimal getDomesticChargeAmt() {
155 return domesticChargeAmt;
156 }
157
158
159 /**
160 * Sets the domesticChargeAmt attribute.
161 *
162 * @param domesticChargeAmt The domesticChargeAmt to set.
163 */
164 public void setDomesticChargeAmt(KualiDecimal domesticChargeAmt) {
165 this.domesticChargeAmt = domesticChargeAmt;
166 }
167
168 /**
169 * Gets the foreignChargeAmt attribute.
170 *
171 * @return Returns the foreignChargeAmt
172 */
173 public KualiDecimal getForeignChargeAmt() {
174 return foreignChargeAmt;
175 }
176
177
178 /**
179 * Sets the foreignChargeAmt attribute.
180 *
181 * @param foreignChargeAmt The foreignChargeAmt to set.
182 */
183 public void setForeignChargeAmt(KualiDecimal foreignChargeAmt) {
184 this.foreignChargeAmt = foreignChargeAmt;
185 }
186
187 /**
188 * Gets the chartOfAccounts attribute.
189 *
190 * @return Returns the chartOfAccounts
191 */
192 public Chart getChartOfAccounts() {
193 return chartOfAccounts;
194 }
195
196
197 /**
198 * Sets the chartOfAccounts attribute.
199 *
200 * @param chartOfAccounts The chartOfAccounts to set.
201 * @deprecated
202 */
203 public void setChartOfAccounts(Chart chartOfAccounts) {
204 this.chartOfAccounts = chartOfAccounts;
205 }
206
207 /**
208 * Gets the incomeFinancialObject attribute.
209 *
210 * @return Returns the incomeFinancialObject
211 */
212 public ObjectCode getIncomeFinancialObject() {
213 return incomeFinancialObject;
214 }
215
216
217 /**
218 * Sets the incomeFinancialObject attribute.
219 *
220 * @param incomeFinancialObject The incomeFinancialObject to set.
221 * @deprecated
222 */
223 public void setIncomeFinancialObject(ObjectCode incomeFinancialObject) {
224 this.incomeFinancialObject = incomeFinancialObject;
225 }
226
227 /**
228 * Gets the expenseFinancialObject attribute.
229 *
230 * @return Returns the expenseFinancialObject
231 */
232 public ObjectCode getExpenseFinancialObject() {
233 return expenseFinancialObject;
234 }
235
236
237 /**
238 * Sets the expenseFinancialObject attribute.
239 *
240 * @param expenseFinancialObject The expenseFinancialObject to set.
241 * @deprecated
242 */
243 public void setExpenseFinancialObject(ObjectCode expenseFinancialObject) {
244 this.expenseFinancialObject = expenseFinancialObject;
245 }
246
247 /**
248 * Gets the account attribute.
249 *
250 * @return Returns the account
251 */
252 public Account getAccount() {
253 return account;
254 }
255
256
257 /**
258 * Sets the account attribute.
259 *
260 * @param account The account to set.
261 * @deprecated
262 */
263 public void setAccount(Account account) {
264 this.account = account;
265 }
266
267 /**
268 * @return Returns the fiscalYear.
269 */
270 public SystemOptions getFiscalYear() {
271 return fiscalYear;
272 }
273
274
275 /**
276 * @param fiscalYear The fiscalYear to set.
277 */
278 public void setFiscalYear(SystemOptions fiscalYear) {
279 this.fiscalYear = fiscalYear;
280 }
281
282 /**
283 * This method (a hack by any other name...) returns a string so that an wire charge can have a link to view its own
284 * inquiry page after a look up
285 *
286 * @return the String "View Wire Charge"
287 */
288 public String getWireChargeViewer() {
289 return "View Wire Charge";
290 }
291
292 /**
293 * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
294 */
295 protected LinkedHashMap toStringMapper() {
296 LinkedHashMap m = new LinkedHashMap();
297 m.put("universityFiscalYear", getUniversityFiscalYear());
298 return m;
299 }
300 }