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