01: /*
02: * Copyright 2006-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.financial.document;
17:
18: import org.kuali.core.util.KualiDecimal;
19: import org.kuali.kfs.document.AccountingDocument;
20:
21: /**
22: * Interface for voucher type documents that require debit/credit support
23: */
24: public interface VoucherDocument extends AccountingDocument {
25:
26: /**
27: * This method retrieves the reversal date associated with this document.
28: *
29: * @return java.sql.Date
30: */
31: public java.sql.Date getReversalDate();
32:
33: /**
34: * This method sets the reversal date associated with this document.
35: *
36: * @param reversalDate
37: */
38: public void setReversalDate(java.sql.Date reversalDate);
39:
40: /**
41: * This method calculates the debit total for a voucher document keying off of the debit/debit code, only summing the accounting
42: * lines with a debitDebitCode that matched the debit constant, and returns the results.
43: *
44: * @return KualiDecimal
45: */
46: public KualiDecimal getDebitTotal();
47:
48: /**
49: * This method calculates the credit total for a voucher document keying off of the debit/credit code, only summing the
50: * accounting lines with a debitCreditCode that matched the debit constant, and returns the results.
51: *
52: * @return KualiDecimal
53: */
54: public KualiDecimal getCreditTotal();
55: }
|