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.sys.KFSPropertyConstants;
022 import org.kuali.rice.kns.bo.PersistableBusinessObjectBase;
023 import org.kuali.rice.kns.util.KualiDecimal;
024
025 /**
026 * Represents a cashiering document
027 */
028 public class CashieringDocument extends PersistableBusinessObjectBase {
029
030 private String documentNumber;
031 private String depositFinancialSystemOriginationCode;
032 private String financialDocumentDepositNumber;
033 private KualiDecimal financialDocumentCheckAmount;
034 private KualiDecimal financialDocumentAdvanceDepositAmount;
035 private KualiDecimal financialDocumentRevolvingFundAmount;
036 private Integer financialDocumentNextCreditCardLineNumber;
037 private KualiDecimal financialDocumentCashAmount;
038 private KualiDecimal financialDocumentCreditCardAmount;
039 private KualiDecimal financialDocumentTotalCoinAmount;
040 private KualiDecimal financialDocumentChangeOutAmount;
041 private Integer nextCheckLineNumber;
042 private Integer nextAdvanceDepositLineNumber;
043 private Integer nextRevolvingFundLineNumber;
044
045 /**
046 * Default constructor.
047 */
048 public CashieringDocument() {
049
050 }
051
052 /**
053 * Gets the documentNumber attribute.
054 *
055 * @return Returns the documentNumber
056 */
057 public String getDocumentNumber() {
058 return documentNumber;
059 }
060
061 /**
062 * Sets the documentNumber attribute.
063 *
064 * @param documentNumber The documentNumber to set.
065 */
066 public void setDocumentNumber(String documentNumber) {
067 this.documentNumber = documentNumber;
068 }
069
070
071 /**
072 * Gets the depositFinancialSystemOriginationCode attribute.
073 *
074 * @return Returns the depositFinancialSystemOriginationCode
075 */
076 public String getDepositFinancialSystemOriginationCode() {
077 return depositFinancialSystemOriginationCode;
078 }
079
080 /**
081 * Sets the depositFinancialSystemOriginationCode attribute.
082 *
083 * @param depositFinancialSystemOriginationCode The depositFinancialSystemOriginationCode to set.
084 */
085 public void setDepositFinancialSystemOriginationCode(String depositFinancialSystemOriginationCode) {
086 this.depositFinancialSystemOriginationCode = depositFinancialSystemOriginationCode;
087 }
088
089
090 /**
091 * Gets the financialDocumentDepositNumber attribute.
092 *
093 * @return Returns the financialDocumentDepositNumber
094 */
095 public String getFinancialDocumentDepositNumber() {
096 return financialDocumentDepositNumber;
097 }
098
099 /**
100 * Sets the financialDocumentDepositNumber attribute.
101 *
102 * @param financialDocumentDepositNumber The financialDocumentDepositNumber to set.
103 */
104 public void setFinancialDocumentDepositNumber(String financialDocumentDepositNumber) {
105 this.financialDocumentDepositNumber = financialDocumentDepositNumber;
106 }
107
108
109 /**
110 * Gets the financialDocumentCheckAmount attribute.
111 *
112 * @return Returns the financialDocumentCheckAmount
113 */
114 public KualiDecimal getFinancialDocumentCheckAmount() {
115 return financialDocumentCheckAmount;
116 }
117
118 /**
119 * Sets the financialDocumentCheckAmount attribute.
120 *
121 * @param financialDocumentCheckAmount The financialDocumentCheckAmount to set.
122 */
123 public void setFinancialDocumentCheckAmount(KualiDecimal financialDocumentCheckAmount) {
124 this.financialDocumentCheckAmount = financialDocumentCheckAmount;
125 }
126
127
128 /**
129 * Gets the financialDocumentAdvanceDepositAmount attribute.
130 *
131 * @return Returns the financialDocumentAdvanceDepositAmount
132 */
133 public KualiDecimal getFinancialDocumentAdvanceDepositAmount() {
134 return financialDocumentAdvanceDepositAmount;
135 }
136
137 /**
138 * Sets the financialDocumentAdvanceDepositAmount attribute.
139 *
140 * @param financialDocumentAdvanceDepositAmount The financialDocumentAdvanceDepositAmount to set.
141 */
142 public void setFinancialDocumentAdvanceDepositAmount(KualiDecimal financialDocumentAdvanceDepositAmount) {
143 this.financialDocumentAdvanceDepositAmount = financialDocumentAdvanceDepositAmount;
144 }
145
146
147 /**
148 * Gets the financialDocumentRevolvingFundAmount attribute.
149 *
150 * @return Returns the financialDocumentRevolvingFundAmount
151 */
152 public KualiDecimal getFinancialDocumentRevolvingFundAmount() {
153 return financialDocumentRevolvingFundAmount;
154 }
155
156 /**
157 * Sets the financialDocumentRevolvingFundAmount attribute.
158 *
159 * @param financialDocumentRevolvingFundAmount The financialDocumentRevolvingFundAmount to set.
160 */
161 public void setFinancialDocumentRevolvingFundAmount(KualiDecimal financialDocumentRevolvingFundAmount) {
162 this.financialDocumentRevolvingFundAmount = financialDocumentRevolvingFundAmount;
163 }
164
165
166 /**
167 * Gets the financialDocumentNextCreditCardLineNumber attribute.
168 *
169 * @return Returns the financialDocumentNextCreditCardLineNumber
170 */
171 public Integer getFinancialDocumentNextCreditCardLineNumber() {
172 return financialDocumentNextCreditCardLineNumber;
173 }
174
175 /**
176 * Sets the financialDocumentNextCreditCardLineNumber attribute.
177 *
178 * @param financialDocumentNextCreditCardLineNumber The financialDocumentNextCreditCardLineNumber to set.
179 */
180 public void setFinancialDocumentNextCreditCardLineNumber(Integer financialDocumentNextCreditCardLineNumber) {
181 this.financialDocumentNextCreditCardLineNumber = financialDocumentNextCreditCardLineNumber;
182 }
183
184
185 /**
186 * Gets the financialDocumentCashAmount attribute.
187 *
188 * @return Returns the financialDocumentCashAmount
189 */
190 public KualiDecimal getFinancialDocumentCashAmount() {
191 return financialDocumentCashAmount;
192 }
193
194 /**
195 * Sets the financialDocumentCashAmount attribute.
196 *
197 * @param financialDocumentCashAmount The financialDocumentCashAmount to set.
198 */
199 public void setFinancialDocumentCashAmount(KualiDecimal financialDocumentCashAmount) {
200 this.financialDocumentCashAmount = financialDocumentCashAmount;
201 }
202
203
204 /**
205 * Gets the financialDocumentCreditCardAmount attribute.
206 *
207 * @return Returns the financialDocumentCreditCardAmount
208 */
209 public KualiDecimal getFinancialDocumentCreditCardAmount() {
210 return financialDocumentCreditCardAmount;
211 }
212
213 /**
214 * Sets the financialDocumentCreditCardAmount attribute.
215 *
216 * @param financialDocumentCreditCardAmount The financialDocumentCreditCardAmount to set.
217 */
218 public void setFinancialDocumentCreditCardAmount(KualiDecimal financialDocumentCreditCardAmount) {
219 this.financialDocumentCreditCardAmount = financialDocumentCreditCardAmount;
220 }
221
222
223 /**
224 * Gets the financialDocumentTotalCoinAmount attribute.
225 *
226 * @return Returns the financialDocumentTotalCoinAmount
227 */
228 public KualiDecimal getFinancialDocumentTotalCoinAmount() {
229 return financialDocumentTotalCoinAmount;
230 }
231
232 /**
233 * Sets the financialDocumentTotalCoinAmount attribute.
234 *
235 * @param financialDocumentTotalCoinAmount The financialDocumentTotalCoinAmount to set.
236 */
237 public void setFinancialDocumentTotalCoinAmount(KualiDecimal financialDocumentTotalCoinAmount) {
238 this.financialDocumentTotalCoinAmount = financialDocumentTotalCoinAmount;
239 }
240
241
242 /**
243 * Gets the financialDocumentChangeOutAmount attribute.
244 *
245 * @return Returns the financialDocumentChangeOutAmount
246 */
247 public KualiDecimal getFinancialDocumentChangeOutAmount() {
248 return financialDocumentChangeOutAmount;
249 }
250
251 /**
252 * Sets the financialDocumentChangeOutAmount attribute.
253 *
254 * @param financialDocumentChangeOutAmount The financialDocumentChangeOutAmount to set.
255 */
256 public void setFinancialDocumentChangeOutAmount(KualiDecimal financialDocumentChangeOutAmount) {
257 this.financialDocumentChangeOutAmount = financialDocumentChangeOutAmount;
258 }
259
260
261 /**
262 * Gets the nextCheckLineNumber attribute.
263 *
264 * @return Returns the nextCheckLineNumber
265 */
266 public Integer getNextCheckLineNumber() {
267 return nextCheckLineNumber;
268 }
269
270 /**
271 * Sets the nextCheckLineNumber attribute.
272 *
273 * @param nextCheckLineNumber The nextCheckLineNumber to set.
274 */
275 public void setNextCheckLineNumber(Integer nextCheckLineNumber) {
276 this.nextCheckLineNumber = nextCheckLineNumber;
277 }
278
279
280 /**
281 * Gets the nextAdvanceDepositLineNumber attribute.
282 *
283 * @return Returns the nextAdvanceDepositLineNumber
284 */
285 public Integer getNextAdvanceDepositLineNumber() {
286 return nextAdvanceDepositLineNumber;
287 }
288
289 /**
290 * Sets the nextAdvanceDepositLineNumber attribute.
291 *
292 * @param nextAdvanceDepositLineNumber The nextAdvanceDepositLineNumber to set.
293 */
294 public void setNextAdvanceDepositLineNumber(Integer nextAdvanceDepositLineNumber) {
295 this.nextAdvanceDepositLineNumber = nextAdvanceDepositLineNumber;
296 }
297
298
299 /**
300 * Gets the nextRevolvingFundLineNumber attribute.
301 *
302 * @return Returns the nextRevolvingFundLineNumber
303 */
304 public Integer getNextRevolvingFundLineNumber() {
305 return nextRevolvingFundLineNumber;
306 }
307
308 /**
309 * Sets the nextRevolvingFundLineNumber attribute.
310 *
311 * @param nextRevolvingFundLineNumber The nextRevolvingFundLineNumber to set.
312 */
313 public void setNextRevolvingFundLineNumber(Integer nextRevolvingFundLineNumber) {
314 this.nextRevolvingFundLineNumber = nextRevolvingFundLineNumber;
315 }
316
317
318 /**
319 * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
320 */
321 protected LinkedHashMap toStringMapper() {
322 LinkedHashMap m = new LinkedHashMap();
323 m.put(KFSPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
324 return m;
325 }
326 }