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     * Created on Oct 12, 2005
018     *
019     */
020    package org.kuali.kfs.gl.businessobject;
021    
022    import java.sql.Date;
023    
024    import org.kuali.kfs.coa.businessobject.Account;
025    import org.kuali.kfs.coa.businessobject.BalanceType;
026    import org.kuali.kfs.coa.businessobject.Chart;
027    import org.kuali.kfs.coa.businessobject.ObjectCode;
028    import org.kuali.kfs.coa.businessobject.ObjectType;
029    import org.kuali.kfs.coa.businessobject.SubAccount;
030    import org.kuali.kfs.coa.businessobject.SubObjectCode;
031    import org.kuali.kfs.sys.businessobject.SystemOptions;
032    import org.kuali.rice.kew.doctype.bo.DocumentTypeEBO;
033    import org.kuali.rice.kns.bo.BusinessObject;
034    import org.kuali.rice.kns.util.KualiDecimal;
035    
036    /**
037     * This interface represents a financial transaction
038     */
039    public interface Transaction extends BusinessObject {
040        public String getAccountNumber();
041    
042        public String getFinancialBalanceTypeCode();
043    
044        public String getChartOfAccountsCode();
045    
046        public String getTransactionDebitCreditCode();
047    
048        public String getDocumentNumber();
049    
050        public Date getFinancialDocumentReversalDate();
051    
052        public String getFinancialDocumentTypeCode();
053    
054        public String getTransactionEncumbranceUpdateCode();
055    
056        public String getFinancialObjectCode();
057    
058        public String getFinancialObjectTypeCode();
059    
060        public String getOrganizationDocumentNumber();
061    
062        public String getOrganizationReferenceId();
063    
064        public String getFinancialSystemOriginationCode();
065    
066        public String getProjectCode();
067    
068        public String getReferenceFinancialDocumentNumber();
069    
070        public String getReferenceFinancialDocumentTypeCode();
071    
072        public String getReferenceFinancialSystemOriginationCode();
073    
074        public String getSubAccountNumber();
075    
076        public String getFinancialSubObjectCode();
077    
078        public Date getTransactionDate();
079    
080        public Integer getTransactionLedgerEntrySequenceNumber();
081    
082        public KualiDecimal getTransactionLedgerEntryAmount();
083    
084        public String getTransactionLedgerEntryDescription();
085    
086        public String getUniversityFiscalPeriodCode();
087    
088        public Integer getUniversityFiscalYear();
089    
090        // bo mappings
091        public Chart getChart();
092    
093        public Account getAccount();
094    
095        public ObjectCode getFinancialObject();
096    
097        public BalanceType getBalanceType();
098    
099        public SystemOptions getOption();
100    
101        public ObjectType getObjectType();
102    
103        public void refreshNonUpdateableReferences();
104    
105        public SubAccount getSubAccount();
106    
107        public SubObjectCode getFinancialSubObject();
108    
109        public DocumentTypeEBO getFinancialSystemDocumentTypeCode();
110        
111        public void setChart(Chart chart);
112    
113        public void setAccount(Account account);
114    
115        public void setFinancialObject(ObjectCode objectCode);
116    
117        public void setBalanceType(BalanceType balanceTyp);
118    
119        public void setOption(SystemOptions options);
120    
121        public void setObjectType(ObjectType objectType);
122    }