View Javadoc
1   /*
2    * The Kuali Financial System, a comprehensive financial management system for higher education.
3    * 
4    * Copyright 2005-2014 The Kuali Foundation
5    * 
6    * This program is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU Affero General Public License as
8    * published by the Free Software Foundation, either version 3 of the
9    * License, or (at your option) any later version.
10   * 
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU Affero General Public License for more details.
15   * 
16   * You should have received a copy of the GNU Affero General Public License
17   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  /*
20   * Created on Oct 12, 2005
21   *
22   */
23  package org.kuali.kfs.gl.businessobject;
24  
25  import java.sql.Date;
26  
27  import org.kuali.kfs.coa.businessobject.Account;
28  import org.kuali.kfs.coa.businessobject.BalanceType;
29  import org.kuali.kfs.coa.businessobject.Chart;
30  import org.kuali.kfs.coa.businessobject.ObjectCode;
31  import org.kuali.kfs.coa.businessobject.ObjectType;
32  import org.kuali.kfs.coa.businessobject.SubAccount;
33  import org.kuali.kfs.coa.businessobject.SubObjectCode;
34  import org.kuali.kfs.sys.businessobject.SystemOptions;
35  import org.kuali.rice.core.api.util.type.KualiDecimal;
36  import org.kuali.rice.kew.doctype.bo.DocumentTypeEBO;
37  import org.kuali.rice.krad.bo.BusinessObject;
38  
39  /**
40   * This interface represents a financial transaction
41   */
42  public interface Transaction extends BusinessObject {
43      public String getAccountNumber();
44  
45      public String getFinancialBalanceTypeCode();
46  
47      public String getChartOfAccountsCode();
48  
49      public String getTransactionDebitCreditCode();
50  
51      public String getDocumentNumber();
52  
53      public Date getFinancialDocumentReversalDate();
54  
55      public String getFinancialDocumentTypeCode();
56  
57      public String getTransactionEncumbranceUpdateCode();
58  
59      public String getFinancialObjectCode();
60  
61      public String getFinancialObjectTypeCode();
62  
63      public String getOrganizationDocumentNumber();
64  
65      public String getOrganizationReferenceId();
66  
67      public String getFinancialSystemOriginationCode();
68  
69      public String getProjectCode();
70  
71      public String getReferenceFinancialDocumentNumber();
72  
73      public String getReferenceFinancialDocumentTypeCode();
74  
75      public String getReferenceFinancialSystemOriginationCode();
76  
77      public String getSubAccountNumber();
78  
79      public String getFinancialSubObjectCode();
80  
81      public Date getTransactionDate();
82  
83      public Integer getTransactionLedgerEntrySequenceNumber();
84  
85      public KualiDecimal getTransactionLedgerEntryAmount();
86  
87      public String getTransactionLedgerEntryDescription();
88  
89      public String getUniversityFiscalPeriodCode();
90  
91      public Integer getUniversityFiscalYear();
92  
93      // bo mappings
94      public Chart getChart();
95  
96      public Account getAccount();
97  
98      public ObjectCode getFinancialObject();
99  
100     public BalanceType getBalanceType();
101 
102     public SystemOptions getOption();
103 
104     public ObjectType getObjectType();
105 
106     public void refreshNonUpdateableReferences();
107 
108     public SubAccount getSubAccount();
109 
110     public SubObjectCode getFinancialSubObject();
111 
112     public DocumentTypeEBO getFinancialSystemDocumentTypeCode();
113     
114     public void setChart(Chart chart);
115 
116     public void setAccount(Account account);
117 
118     public void setFinancialObject(ObjectCode objectCode);
119 
120     public void setBalanceType(BalanceType balanceTyp);
121 
122     public void setOption(SystemOptions options);
123 
124     public void setObjectType(ObjectType objectType);
125 }