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.gl.businessobject;
017
018 import java.sql.Date;
019
020 import org.kuali.rice.kns.bo.BusinessObject;
021 import org.kuali.rice.kns.util.KualiDecimal;
022
023 /**
024 * Represents an origin entry
025 */
026 public interface OriginEntryInformation extends BusinessObject {
027
028 /**
029 * gets the transactionLedgerEntryDescription attribute value
030 *
031 * @return
032 */
033 String getTransactionLedgerEntryDescription();
034
035 /**
036 * sets the transactionLedgerEntryDescription attribute value
037 *
038 * @param transactionLedgerEntryDescription
039 */
040 void setTransactionLedgerEntryDescription(String transactionLedgerEntryDescription);
041
042 /**
043 * gets the documentNumber attribute value
044 *
045 * @return
046 */
047 String getDocumentNumber();
048
049 /**
050 * sets the documentNumber attribute value
051 *
052 * @param documentNumber
053 */
054 void setDocumentNumber(String documentNumber);
055
056 /**
057 * This gets the origin entry in its standard string output form
058 *
059 * @return
060 */
061 String getLine();
062
063 /**
064 * gets the referenceFinancialDocumentNumber attribute value
065 *
066 * @return
067 */
068 String getReferenceFinancialDocumentNumber();
069
070 /**
071 * sets the referenceFinancialDocumentNumber attribute value
072 *
073 * @param referenceFinancialDocumentNumber
074 */
075 void setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber);
076
077 /**
078 * gets the organizationReferenceId attribute value
079 *
080 * @return
081 */
082 String getOrganizationReferenceId();
083
084 /**
085 * sets the organizationReferenceId attribute value
086 *
087 * @param organizationReferenceId
088 */
089 void setOrganizationReferenceId(String organizationReferenceId);
090
091 /**
092 * gets the accountNumber attribute value
093 *
094 * @return
095 */
096 String getAccountNumber();
097
098 /**
099 * sets the accountNumber attribute value
100 *
101 * @param accountNumber
102 */
103 void setAccountNumber(String accountNumber);
104
105 /**
106 * gets the subAccountNumber attribute value
107 *
108 * @return
109 */
110 String getSubAccountNumber();
111
112 /**
113 * sets the subAccountNumber attribute value
114 *
115 * @param subAccountNumber
116 */
117 void setSubAccountNumber(String subAccountNumber);
118
119 /**
120 * gets the chartOfAccountsCode attribute value
121 *
122 * @return
123 */
124 String getChartOfAccountsCode();
125
126 /**
127 * sets the chartOfAccountsCode attribute value
128 *
129 * @param chartOfAccountsCode
130 */
131 void setChartOfAccountsCode(String chartOfAccountsCode);
132
133 /**
134 * gets the projectCode attribute value
135 *
136 * @return
137 */
138 String getProjectCode();
139
140 /**
141 * sets the projectCode attribute value
142 *
143 * @param projectCode
144 */
145 void setProjectCode(String projectCode);
146
147 /**
148 * gets the universityFiscalYear attribute value
149 *
150 * @return
151 */
152 Integer getUniversityFiscalYear();
153
154 /**
155 * sets the universityFiscalYear attribute value
156 *
157 * @param fiscalYear
158 */
159 void setUniversityFiscalYear(Integer fiscalYear);
160
161 /**
162 * gets the transactionDate attribute value
163 *
164 * @return
165 */
166 Date getTransactionDate();
167
168 /**
169 * sets the transactionDate attribute value
170 *
171 * @param transactionDate
172 */
173 void setTransactionDate(Date transactionDate);
174
175 /**
176 * gets the financialDocumentTypeCode attribute value
177 *
178 * @return
179 */
180 String getFinancialDocumentTypeCode();
181
182 /**
183 * sets the financialDocumentTypeCode attribute value
184 *
185 * @param financialDocumentTypeCode
186 */
187 void setFinancialDocumentTypeCode(String financialDocumentTypeCode);
188
189 /**
190 * gets the financialSystemOriginationCode attribute value
191 *
192 * @return
193 */
194 String getFinancialSystemOriginationCode();
195
196 /**
197 * sets the financialSystemOriginationCode attribute value
198 *
199 * @param origCode
200 */
201 void setFinancialSystemOriginationCode(String origCode);
202
203 /**
204 * gets the financialObjectCode attribute value
205 *
206 * @return
207 */
208 String getFinancialObjectCode();
209
210 /**
211 * sets the financialObjectCode attribute value
212 *
213 * @param financialObjectCode
214 */
215 void setFinancialObjectCode(String financialObjectCode);
216
217 /**
218 * gets the financialObjectTypeCode attribute value
219 *
220 * @return
221 */
222 String getFinancialObjectTypeCode();
223
224 /**
225 * sets the financialObjectTypeCode attribute value
226 *
227 * @param financialObjectTypeCode
228 */
229 void setFinancialObjectTypeCode(String financialObjectTypeCode);
230
231 /**
232 * gets the financialSubObjectCode attribute value
233 *
234 * @return
235 */
236 String getFinancialSubObjectCode();
237
238 /**
239 * sets the financialSubObjectCode attribute value
240 *
241 * @param financialSubObjectCode
242 */
243 void setFinancialSubObjectCode(String financialSubObjectCode);
244
245 /**
246 * gets the transactionLedgerEntryAmount attribute value
247 *
248 * @return
249 */
250 KualiDecimal getTransactionLedgerEntryAmount();
251
252 /**
253 * sets the transactionLedgerEntryAmount attribute value
254 *
255 * @param amount
256 */
257 void setTransactionLedgerEntryAmount(KualiDecimal amount);
258
259 /**
260 * gets the transactionDebitCreditCode attribute value
261 *
262 * @return
263 */
264 String getTransactionDebitCreditCode();
265
266 /**
267 * sets the transactionDebitCreditCode attribute value
268 *
269 * @param debitCreditCode
270 */
271 void setTransactionDebitCreditCode(String debitCreditCode);
272
273 /**
274 * gets the financialBalanceTypeCode attribute value
275 *
276 * @return
277 */
278 String getFinancialBalanceTypeCode();
279
280 /**
281 * sets the financialBalanceTypeCode attribute value
282 *
283 * @param balanceTypeCode
284 */
285 void setFinancialBalanceTypeCode(String balanceTypeCode);
286
287 /**
288 * gets the financialDocumentReversalDate attribute value
289 *
290 * @return
291 */
292 Date getFinancialDocumentReversalDate();
293
294 /**
295 * sets the financialDocumentReversalDate attribute value
296 *
297 * @param reversalDate
298 */
299 void setFinancialDocumentReversalDate(Date reversalDate);
300
301 /**
302 * true if this origin entry is a credit, false otherwise
303 *
304 * @return
305 */
306 boolean isCredit();
307
308 /**
309 * true if this origin entry is a debit, false otherwise
310 *
311 * @return
312 */
313 boolean isDebit();
314
315 /**
316 * gets the universityFiscalPeriodCode attribute value
317 *
318 * @return
319 */
320 String getUniversityFiscalPeriodCode();
321
322 /**
323 * sets the universityFiscalPeriodCode attribute value
324 *
325 * @param fiscalPeriodCode
326 */
327 void setUniversityFiscalPeriodCode(String fiscalPeriodCode);
328
329 /**
330 * gets the referenceFinancialDocumentTypeCode attribute value
331 *
332 * @return
333 */
334 String getReferenceFinancialDocumentTypeCode();
335
336 /**
337 * sets the referenceFinancialDocumentTypeCode attribute value
338 *
339 * @param refernenceFinancialDocumentTypeCode
340 */
341 void setReferenceFinancialDocumentTypeCode(String refernenceFinancialDocumentTypeCode);
342
343 /**
344 * gets the referenceFinancialSystemOriginationCode attribute value
345 *
346 * @return
347 */
348 String getReferenceFinancialSystemOriginationCode();
349
350 /**
351 * sets referenceFinancialSystemOriginationCode attribute value
352 *
353 * @param referenceFinancialSystemOriginationCode
354 */
355 void setReferenceFinancialSystemOriginationCode(String referenceFinancialSystemOriginationCode);
356
357 /**
358 * gets transactionEncumbranceUpdateCode attribute value
359 *
360 * @return
361 */
362 String getTransactionEncumbranceUpdateCode();
363
364 /**
365 * sets transactionEncumbranceUpdateCode attribute value
366 *
367 * @param code
368 */
369 void setTransactionEncumbranceUpdateCode(String code);
370
371 /**
372 * gets the organizationDocumentNumber attribute value
373 *
374 * @return
375 */
376 String getOrganizationDocumentNumber();
377
378 /**
379 * sets the organizationDocumentNumber attribute value
380 *
381 * @param organizationDocumentNumber
382 */
383 void setOrganizationDocumentNumber(String organizationDocumentNumber);
384
385 /**
386 * gets the transactionLedgerEntrySequenceNumber attribute value
387 *
388 * @return
389 */
390 Integer getTransactionLedgerEntrySequenceNumber();
391
392 /**
393 * sets the transactionLedgerEntrySequenceNumber attribute value
394 *
395 * @param transactionLedgerEntrySequenceNumber
396 */
397 void setTransactionLedgerEntrySequenceNumber(Integer transactionLedgerEntrySequenceNumber);
398
399 /**
400 * gets the transactionScrubberOffsetGenerationIndicator attribute value
401 *
402 * @param b
403 */
404 void setTransactionScrubberOffsetGenerationIndicator(boolean b);
405
406 /**
407 * sets the entryGroupId attribute value
408 *
409 * @param groupId
410 */
411 void setEntryGroupId(Integer groupId);
412
413 /**
414 * This method forces the origin entryable to reset its id to null
415 */
416 void resetEntryId();
417 }