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 package org.kuali.kfs.module.endow.businessobject;
017
018 import java.math.BigDecimal;
019 import java.util.List;
020
021 import org.kuali.rice.kns.bo.PersistableBusinessObject;
022 import org.kuali.rice.kns.util.KualiDecimal;
023 import org.kuali.rice.kns.util.KualiInteger;
024
025 public interface EndowmentTransactionLine extends PersistableBusinessObject {
026
027 /**
028 * Get the documentNumber
029 *
030 * @return documentNumber
031 */
032 public String getDocumentNumber();
033
034 /**
035 * Set the documentNumber
036 *
037 * @param documentNumber
038 */
039 public void setDocumentNumber(String documentNumber);
040
041 /**
042 * Gets the transactionLineTypeCode.
043 *
044 * @return transactionLineTypeCode
045 */
046 public String getTransactionLineTypeCode();
047
048 /**
049 *Sets the transactionLineTypeCode.
050 *
051 * @param transactionLineTypeCode
052 */
053 public void setTransactionLineTypeCode(String transactionLineTypeCode);
054
055 /**
056 * Gets the transactionLineNumber.
057 *
058 * @return transactionLineNumber
059 */
060 public Integer getTransactionLineNumber();
061
062 /**
063 * Sets the transactionLineNumber.
064 *
065 * @param transactionLineNumber
066 */
067 public void setTransactionLineNumber(Integer transactionLineNumber);
068
069 /**
070 * @return Returns the kemid.
071 */
072 public String getKemid();
073
074 /**
075 * @param kemid The kemid to set.
076 */
077 public void setKemid(String kemid);
078
079 /**
080 * @return Returns the kemid object.
081 */
082 public KEMID getKemidObj();
083
084 /**
085 * @param kemidObj The kemid object to set.
086 */
087 public void setKemidObj(KEMID kemidObj);
088
089 /**
090 * @return Returns the endowment transaction type code.
091 */
092 public String getEtranCode();
093
094 /**
095 * @param endowmentTransactionTypeCode The endowment transaction type code to set.
096 */
097 public void setEtranCode(String endowmentTransactionTypeCode);
098
099 /**
100 * @return Returns the EndowmentTransactionCode object.
101 */
102 public EndowmentTransactionCode getEtranCodeObj();
103
104 /**
105 * @param etranCodeObj the EndowmentTransactionCode object to set.
106 */
107 public void setEtranCodeObj(EndowmentTransactionCode etranCodeObj);
108
109 /**
110 * @return Returns the transaction line description.
111 */
112 public String getTransactionLineDescription();
113
114 /**
115 * @param description The transaction line description to set.
116 */
117 public void setTransactionLineDescription(String description);
118
119 /**
120 * @return Returns the income/principal indicator code.
121 */
122 public String getTransactionIPIndicatorCode();
123
124 /**
125 * @param ipIndicator The income/principal indicator code to set.
126 */
127 public void setTransactionIPIndicatorCode(String ipIndicator);
128
129 /**
130 * @return Returns the income/principal indicator.
131 */
132 public IncomePrincipalIndicator getIncomePrincipalIndicator();
133
134 /**
135 * @param incomePrincipalIndicator The income/principal indicator to set.
136 */
137 // Do we need this?
138 public void setIncomePrincipalIndicator(IncomePrincipalIndicator incomePrincipalIndicator);
139
140 /**
141 * @return Returns the transaction amount.
142 */
143 public KualiDecimal getTransactionAmount();
144
145 /**
146 * @param amount The transaction amount to set.
147 */
148 public void setTransactionAmount(KualiDecimal amount);
149
150 /**
151 * @return Returns the corpus indicator -- Y or N.
152 */
153 public boolean getCorpusIndicator();
154
155 /**
156 * @param corpusIndicator The corpus indicator to set.
157 */
158 public void setCorpusIndicator(boolean corpusIndicator);
159
160 /**
161 * @return Returns the transaction units.
162 */
163 public KualiDecimal getTransactionUnits();
164
165 /**
166 * @param units The transaction units to set.
167 */
168 public void setTransactionUnits(KualiDecimal units);
169
170 /**
171 * @return Returns the line posted indicator -- Y or N.
172 */
173 public boolean isLinePosted();
174
175 /**
176 * @param linePostedIndicator The line posted indicator to set.
177 */
178 public void setLinePosted(boolean linePostedIndicator);
179
180 /**
181 * Gets the tax lot lines.
182 *
183 * @return returns the tax lot lines for this transaction line
184 */
185 public List<EndowmentTransactionTaxLotLine> getTaxLotLines();
186
187 /**
188 * Sets the tax lot lines.
189 *
190 * @param taxLotLines
191 */
192 public void setTaxLotLines(List<EndowmentTransactionTaxLotLine> taxLotLines);
193
194 /**
195 * Gets the unit adjustment amount.
196 *
197 * @return returns unit adjustment amount for this transaction line
198 */
199 public BigDecimal getUnitAdjustmentAmount();
200
201 /**
202 * sets unitAdjustmentAmount
203 */
204 public void setUnitAdjustmentAmount(BigDecimal unitAdjustmentAmount);
205 }