View Javadoc

1   /*
2    * Copyright 2005-2006 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  
17  package org.kuali.ole.fp.businessobject;
18  
19  import java.util.LinkedHashMap;
20  
21  import org.kuali.ole.coa.businessobject.Account;
22  import org.kuali.ole.coa.businessobject.Chart;
23  import org.kuali.ole.coa.businessobject.ObjectCode;
24  import org.kuali.ole.sys.businessobject.FiscalYearBasedBusinessObject;
25  import org.kuali.ole.sys.businessobject.SystemOptions;
26  import org.kuali.rice.core.api.util.type.KualiDecimal;
27  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
28  
29  /**
30   * This class is used to represent a Wire Charge business object, which is a method of payment to an institution.
31   */
32  public class WireCharge extends PersistableBusinessObjectBase implements FiscalYearBasedBusinessObject {
33  
34      private Integer universityFiscalYear;
35      private String chartOfAccountsCode;
36      private String accountNumber;
37      private String incomeFinancialObjectCode;
38      private String expenseFinancialObjectCode;
39      private KualiDecimal domesticChargeAmt;
40      private KualiDecimal foreignChargeAmt;
41  
42      private SystemOptions fiscalYear;
43      private Chart chartOfAccounts;
44      private ObjectCode incomeFinancialObject;
45      private ObjectCode expenseFinancialObject;
46      private Account account;
47  
48      /**
49       * Default no-arg constructor.
50       */
51      public WireCharge() {
52  
53      }
54  
55      /**
56       * Gets the universityFiscalYear attribute.
57       * 
58       * @return Returns the universityFiscalYear
59       */
60      public Integer getUniversityFiscalYear() {
61          return universityFiscalYear;
62      }
63  
64  
65      /**
66       * Sets the universityFiscalYear attribute.
67       * 
68       * @param universityFiscalYear The universityFiscalYear to set.
69       */
70      public void setUniversityFiscalYear(Integer universityFiscalYear) {
71          this.universityFiscalYear = universityFiscalYear;
72      }
73  
74      /**
75       * Gets the chartOfAccountsCode attribute.
76       * 
77       * @return Returns the chartOfAccountsCode
78       */
79      public String getChartOfAccountsCode() {
80          return chartOfAccountsCode;
81      }
82  
83  
84      /**
85       * Sets the chartOfAccountsCode attribute.
86       * 
87       * @param chartOfAccountsCode The chartOfAccountsCode to set.
88       */
89      public void setChartOfAccountsCode(String chartOfAccountsCode) {
90          this.chartOfAccountsCode = chartOfAccountsCode;
91      }
92  
93      /**
94       * Gets the accountNumber attribute.
95       * 
96       * @return Returns the accountNumber
97       */
98      public String getAccountNumber() {
99          return accountNumber;
100     }
101 
102 
103     /**
104      * Sets the accountNumber attribute.
105      * 
106      * @param accountNumber The accountNumber to set.
107      */
108     public void setAccountNumber(String accountNumber) {
109         this.accountNumber = accountNumber;
110     }
111 
112     /**
113      * Gets the incomeFinancialObjectCode attribute.
114      * 
115      * @return Returns the incomeFinancialObjectCode
116      */
117     public String getIncomeFinancialObjectCode() {
118         return incomeFinancialObjectCode;
119     }
120 
121 
122     /**
123      * Sets the incomeFinancialObjectCode attribute.
124      * 
125      * @param incomeFinancialObjectCode The incomeFinancialObjectCode to set.
126      */
127     public void setIncomeFinancialObjectCode(String incomeFinancialObjectCode) {
128         this.incomeFinancialObjectCode = incomeFinancialObjectCode;
129     }
130 
131     /**
132      * Gets the expenseFinancialObjectCode attribute.
133      * 
134      * @return Returns the expenseFinancialObjectCode
135      */
136     public String getExpenseFinancialObjectCode() {
137         return expenseFinancialObjectCode;
138     }
139 
140 
141     /**
142      * Sets the expenseFinancialObjectCode attribute.
143      * 
144      * @param expenseFinancialObjectCode The expenseFinancialObjectCode to set.
145      */
146     public void setExpenseFinancialObjectCode(String expenseFinancialObjectCode) {
147         this.expenseFinancialObjectCode = expenseFinancialObjectCode;
148     }
149 
150     /**
151      * Gets the domesticChargeAmt attribute.
152      * 
153      * @return Returns the domesticChargeAmt
154      */
155     public KualiDecimal getDomesticChargeAmt() {
156         return domesticChargeAmt;
157     }
158 
159 
160     /**
161      * Sets the domesticChargeAmt attribute.
162      * 
163      * @param domesticChargeAmt The domesticChargeAmt to set.
164      */
165     public void setDomesticChargeAmt(KualiDecimal domesticChargeAmt) {
166         this.domesticChargeAmt = domesticChargeAmt;
167     }
168 
169     /**
170      * Gets the foreignChargeAmt attribute.
171      * 
172      * @return Returns the foreignChargeAmt
173      */
174     public KualiDecimal getForeignChargeAmt() {
175         return foreignChargeAmt;
176     }
177 
178 
179     /**
180      * Sets the foreignChargeAmt attribute.
181      * 
182      * @param foreignChargeAmt The foreignChargeAmt to set.
183      */
184     public void setForeignChargeAmt(KualiDecimal foreignChargeAmt) {
185         this.foreignChargeAmt = foreignChargeAmt;
186     }
187 
188     /**
189      * Gets the chartOfAccounts attribute.
190      * 
191      * @return Returns the chartOfAccounts
192      */
193     public Chart getChartOfAccounts() {
194         return chartOfAccounts;
195     }
196 
197 
198     /**
199      * Sets the chartOfAccounts attribute.
200      * 
201      * @param chartOfAccounts The chartOfAccounts to set.
202      * @deprecated
203      */
204     public void setChartOfAccounts(Chart chartOfAccounts) {
205         this.chartOfAccounts = chartOfAccounts;
206     }
207 
208     /**
209      * Gets the incomeFinancialObject attribute.
210      * 
211      * @return Returns the incomeFinancialObject
212      */
213     public ObjectCode getIncomeFinancialObject() {
214         return incomeFinancialObject;
215     }
216 
217 
218     /**
219      * Sets the incomeFinancialObject attribute.
220      * 
221      * @param incomeFinancialObject The incomeFinancialObject to set.
222      * @deprecated
223      */
224     public void setIncomeFinancialObject(ObjectCode incomeFinancialObject) {
225         this.incomeFinancialObject = incomeFinancialObject;
226     }
227 
228     /**
229      * Gets the expenseFinancialObject attribute.
230      * 
231      * @return Returns the expenseFinancialObject
232      */
233     public ObjectCode getExpenseFinancialObject() {
234         return expenseFinancialObject;
235     }
236 
237 
238     /**
239      * Sets the expenseFinancialObject attribute.
240      * 
241      * @param expenseFinancialObject The expenseFinancialObject to set.
242      * @deprecated
243      */
244     public void setExpenseFinancialObject(ObjectCode expenseFinancialObject) {
245         this.expenseFinancialObject = expenseFinancialObject;
246     }
247 
248     /**
249      * Gets the account attribute.
250      * 
251      * @return Returns the account
252      */
253     public Account getAccount() {
254         return account;
255     }
256 
257 
258     /**
259      * Sets the account attribute.
260      * 
261      * @param account The account to set.
262      * @deprecated
263      */
264     public void setAccount(Account account) {
265         this.account = account;
266     }
267 
268     /**
269      * @return Returns the fiscalYear.
270      */
271     public SystemOptions getFiscalYear() {
272         return fiscalYear;
273     }
274 
275 
276     /**
277      * @param fiscalYear The fiscalYear to set.
278      */
279     public void setFiscalYear(SystemOptions fiscalYear) {
280         this.fiscalYear = fiscalYear;
281     }
282 
283     /**
284      * This method (a hack by any other name...) returns a string so that an wire charge can have a link to view its own
285      * inquiry page after a look up
286      * 
287      * @return the String "View Wire Charge"
288      */
289     public String getWireChargeViewer() {
290         return "View Wire Charge";
291     }
292 
293     /**
294      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
295      */
296     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
297         LinkedHashMap m = new LinkedHashMap();
298         m.put("universityFiscalYear", getUniversityFiscalYear());
299         return m;
300     }
301 }