001: /*
002: * Copyright 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.kfs.web.struts.form;
017:
018: import org.apache.commons.lang.StringUtils;
019: import org.kuali.core.web.struts.form.KualiForm;
020:
021: /**
022: * This class is the action form for balance inquiries.
023: */
024: public class KualiBalanceInquiryReportMenuForm extends KualiForm {
025: private static final long serialVersionUID = 1L;
026:
027: // parameter fields
028: private String referenceOriginCode;
029: private String referenceNumber;
030: private String referenceTypeCode;
031: private String debitCreditCode;
032: private String chartOfAccountsCode;
033: private String accountNumber;
034: private String financialObjectCode;
035: private String subAccountNumber;
036: private String financialSubObjectCode;
037: private String projectCode;
038: private String objectTypeCode;
039:
040: private String docFormKey;
041: // need this next attribute b/c the lookup overwrites the docFormKey
042: // improperly when it cancels back to the report menu (this)
043: // this holds the official docFormKey for the calling TP eDoc
044: private String balanceInquiryReportMenuCallerDocFormKey;
045: private String backLocation;
046:
047: /**
048: * @return String
049: */
050: public String getBackLocation() {
051: return backLocation;
052: }
053:
054: /**
055: * @param backLocation
056: */
057: public void setBackLocation(String backLocation) {
058: this .backLocation = backLocation;
059: }
060:
061: /**
062: * @return String
063: */
064: public String getDocFormKey() {
065: return docFormKey;
066: }
067:
068: /**
069: * @param docFormKey
070: */
071: public void setDocFormKey(String docFormKey) {
072: this .docFormKey = docFormKey;
073: }
074:
075: /**
076: * Builds out the lookupParameters for the GLPE balance inquiry.
077: *
078: * @return String
079: */
080: public String getGeneralLedgerPendingEntryBalanceInquiryLookupParameters() {
081: return buildGenericBalanceInquiryLookupParameters();
082: }
083:
084: /**
085: * This method builds out the common balance inquiry lookup parameters based upon what was entered in the calling accounting
086: * line.
087: *
088: * @return String
089: */
090: private String buildGenericBalanceInquiryLookupParameters() {
091: String lookupParameters = "";
092:
093: if (StringUtils.isNotBlank(chartOfAccountsCode)) {
094: lookupParameters += "chartOfAccountsCode:chartOfAccountsCode";
095: }
096: if (StringUtils.isNotBlank(accountNumber)) {
097: lookupParameters += ",accountNumber:accountNumber";
098: }
099: if (StringUtils.isNotBlank(subAccountNumber)) {
100: lookupParameters += ",subAccountNumber:subAccountNumber";
101: }
102: if (StringUtils.isNotBlank(financialObjectCode)) {
103: lookupParameters += ",financialObjectCode:financialObjectCode";
104: }
105: if (StringUtils.isNotBlank(financialSubObjectCode)) {
106: lookupParameters += ",financialSubObjectCode:financialSubObjectCode";
107: }
108: if (StringUtils.isNotBlank(objectTypeCode)) {
109: lookupParameters += ",objectTypeCode:financialObjectTypeCode";
110: }
111: if (StringUtils.isNotBlank(debitCreditCode)) {
112: lookupParameters += ",debitCreditCode:transactionDebitCreditCode";
113: }
114: if (StringUtils.isNotBlank(referenceOriginCode)) {
115: lookupParameters += ",referenceOriginCode:referenceFinancialSystemOriginationCode";
116: }
117: if (StringUtils.isNotBlank(referenceTypeCode)) {
118: lookupParameters += ",referenceTypeCode:referenceFinancialDocumentTypeCode";
119: }
120: if (StringUtils.isNotBlank(referenceNumber)) {
121: lookupParameters += ",referenceNumber:referenceFinancialDocumentNumber";
122: }
123: if (StringUtils.isNotBlank(projectCode)) {
124: lookupParameters += ",projectCode:projectCode";
125: }
126:
127: return lookupParameters;
128: }
129:
130: /**
131: * @return String
132: */
133: public String getGeneralLedgerBalanceBalanceInquiryLookupParameters() {
134: return buildGenericBalanceInquiryLookupParameters();
135: }
136:
137: /**
138: * @return String
139: */
140: public String getGeneralLedgerEntryBalanceInquiryLookupParameters() {
141: return buildGenericBalanceInquiryLookupParameters();
142: }
143:
144: /**
145: * @return String
146: */
147: public String getBalancesByConsolidationBalanceInquiryLookupParameters() {
148: return buildGenericBalanceInquiryLookupParameters();
149: }
150:
151: /**
152: * @return String
153: */
154: public String getAvailableBalancesBalanceInquiryLookupParameters() {
155: return buildGenericBalanceInquiryLookupParameters();
156: }
157:
158: /**
159: * @return String
160: */
161: public String getOpenEncumbrancesBalanceInquiryLookupParameters() {
162: return buildGenericBalanceInquiryLookupParameters();
163: }
164:
165: /**
166: * @return String
167: */
168: public String getCashBalancesBalanceInquiryLookupParameters() {
169: return buildGenericBalanceInquiryLookupParameters();
170: }
171:
172: /**
173: * @return String
174: */
175: public String getAccountNumber() {
176: return accountNumber;
177: }
178:
179: /**
180: * @param accountNumber
181: */
182: public void setAccountNumber(String accountNumber) {
183: this .accountNumber = accountNumber;
184: }
185:
186: /**
187: * @return String
188: */
189: public String getChartOfAccountsCode() {
190: return chartOfAccountsCode;
191: }
192:
193: /**
194: * @param chartOfAccountsCode
195: */
196: public void setChartOfAccountsCode(String chartOfAccountsCode) {
197: this .chartOfAccountsCode = chartOfAccountsCode;
198: }
199:
200: /**
201: * @return String
202: */
203: public String getDebitCreditCode() {
204: return debitCreditCode;
205: }
206:
207: /**
208: * @param debitCreditCode
209: */
210: public void setDebitCreditCode(String debitCreditCode) {
211: this .debitCreditCode = debitCreditCode;
212: }
213:
214: /**
215: * @return String
216: */
217: public String getFinancialObjectCode() {
218: return financialObjectCode;
219: }
220:
221: /**
222: * @param financialObjectCode
223: */
224: public void setFinancialObjectCode(String financialObjectCode) {
225: this .financialObjectCode = financialObjectCode;
226: }
227:
228: /**
229: * @return String
230: */
231: public String getFinancialSubObjectCode() {
232: return financialSubObjectCode;
233: }
234:
235: /**
236: * @param financialSubObjectCode
237: */
238: public void setFinancialSubObjectCode(String financialSubObjectCode) {
239: this .financialSubObjectCode = financialSubObjectCode;
240: }
241:
242: /**
243: * @return String
244: */
245: public String getObjectTypeCode() {
246: return objectTypeCode;
247: }
248:
249: /**
250: * @param objectTypeCode
251: */
252: public void setObjectTypeCode(String objectTypeCode) {
253: this .objectTypeCode = objectTypeCode;
254: }
255:
256: /**
257: * @return String
258: */
259: public String getProjectCode() {
260: return projectCode;
261: }
262:
263: /**
264: * @param projectCode
265: */
266: public void setProjectCode(String projectCode) {
267: this .projectCode = projectCode;
268: }
269:
270: /**
271: * @return String
272: */
273: public String getReferenceNumber() {
274: return referenceNumber;
275: }
276:
277: /**
278: * @param referenceNumber
279: */
280: public void setReferenceNumber(String referenceNumber) {
281: this .referenceNumber = referenceNumber;
282: }
283:
284: /**
285: * @return String
286: */
287: public String getReferenceOriginCode() {
288: return referenceOriginCode;
289: }
290:
291: /**
292: * @param referenceOriginCode
293: */
294: public void setReferenceOriginCode(String referenceOriginCode) {
295: this .referenceOriginCode = referenceOriginCode;
296: }
297:
298: /**
299: * @return String
300: */
301: public String getReferenceTypeCode() {
302: return referenceTypeCode;
303: }
304:
305: /**
306: * @param referenceTypeCode
307: */
308: public void setReferenceTypeCode(String referenceTypeCode) {
309: this .referenceTypeCode = referenceTypeCode;
310: }
311:
312: /**
313: * @return String
314: */
315: public String getSubAccountNumber() {
316: return subAccountNumber;
317: }
318:
319: /**
320: * @param subAccountNumber
321: */
322: public void setSubAccountNumber(String subAccountNumber) {
323: this .subAccountNumber = subAccountNumber;
324: }
325:
326: /**
327: * @return String
328: */
329: public String getBalanceInquiryReportMenuCallerDocFormKey() {
330: return balanceInquiryReportMenuCallerDocFormKey;
331: }
332:
333: /**
334: * @param balanceInquiryReportMenuCallerDocFormKey
335: */
336: public void setBalanceInquiryReportMenuCallerDocFormKey(
337: String balanceInquiryReportMenuCallerDocFormKey) {
338: this.balanceInquiryReportMenuCallerDocFormKey = balanceInquiryReportMenuCallerDocFormKey;
339: }
340: }
|