/*
* The Kuali Financial System, a comprehensive financial management system for higher education.
*
* Copyright 2005-2014 The Kuali Foundation
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.kuali.kfs.fp.businessobject.lookup;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import org.kuali.kfs.fp.businessobject.DisbursementPayee;
import org.kuali.kfs.integration.ar.AccountsReceivableCustomer;
import org.kuali.kfs.integration.ar.AccountsReceivableModuleService;
import org.kuali.kfs.sys.KFSConstants;
import org.kuali.kfs.sys.KFSKeyConstants;
import org.kuali.kfs.sys.KFSPropertyConstants;
import org.kuali.kfs.vnd.VendorPropertyConstants;
import org.kuali.rice.kim.impl.KIMPropertyConstants;
import org.kuali.rice.kns.util.KNSGlobalVariables;
import org.kuali.rice.kns.util.MessageList;
import org.kuali.rice.kns.web.struts.form.LookupForm;
import org.kuali.rice.kns.web.ui.ResultRow;
import org.kuali.rice.krad.bo.BusinessObject;
import org.kuali.rice.krad.exception.ValidationException;
import org.kuali.rice.krad.lookup.CollectionIncomplete;
import org.kuali.rice.krad.util.BeanPropertyComparator;
import org.kuali.rice.krad.util.GlobalVariables;
public class DisbursementPayeeLookupableHelperServiceImpl extends AbstractPayeeLookupableHelperServiceImpl {
private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DisbursementPayeeLookupableHelperServiceImpl.class);
private static final int NAME_REQUIRED_FILLED_WITH_WILDCARD = 4;
private AccountsReceivableModuleService accountsReceivableModuleService;
/**
* @see org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl#validateSearchParameters(java.util.Map)
*/
@Override
public void validateSearchParameters(Map fieldValues) {
super.validateSearchParameters(fieldValues);
if (checkMinimumFieldsFilled(fieldValues)) {
validateVendorNameUse(fieldValues);
validateTaxNumberCriteria(fieldValues);
validateEmployeeNameUse(fieldValues);
}
if (GlobalVariables.getMessageMap().hasErrors()) {
throw new ValidationException("errors in search criteria");
}
}
// get the search criteria valid for vendor lookup
@Override
protected Map<String, String> getVendorFieldValues(Map<String, String> fieldValues) {
Map<String, String> vendorFieldValues = new HashMap<String, String>();
vendorFieldValues.put(KFSPropertyConstants.TAX_NUMBER, fieldValues.get(KFSPropertyConstants.TAX_NUMBER));
vendorFieldValues.put(KFSPropertyConstants.VENDOR_NAME, fieldValues.get(KFSPropertyConstants.VENDOR_NAME));
vendorFieldValues.put(KFSPropertyConstants.VENDOR_NUMBER, fieldValues.get(KFSPropertyConstants.VENDOR_NUMBER));
vendorFieldValues.put(KFSPropertyConstants.PERSON_FIRST_NAME, fieldValues.get(KFSPropertyConstants.PERSON_FIRST_NAME));
vendorFieldValues.put(KFSPropertyConstants.PERSON_LAST_NAME, fieldValues.get(KFSPropertyConstants.PERSON_LAST_NAME));
vendorFieldValues.put(KFSPropertyConstants.ACTIVE, fieldValues.get(KFSPropertyConstants.ACTIVE));
Map<String, String> fieldConversionMap = disbursementVoucherPayeeService.getFieldConversionBetweenPayeeAndVendor();
this.replaceFieldKeys(vendorFieldValues, fieldConversionMap);
String vendorName = this.getVendorName(vendorFieldValues);
if (StringUtils.isNotBlank(vendorName)) {
vendorFieldValues.put(KFSPropertyConstants.VENDOR_NAME, vendorName);
}
vendorFieldValues.remove(VendorPropertyConstants.VENDOR_FIRST_NAME);
vendorFieldValues.remove(VendorPropertyConstants.VENDOR_LAST_NAME);
return vendorFieldValues;
}
// gets the search criteria valid for person lookup, from the specified field value map.
@Override
protected Map<String, String> getPersonFieldValues(Map<String, String> fieldValues) {
Map<String, String> personFieldValues = new HashMap<String, String>();
personFieldValues.put(KFSPropertyConstants.PERSON_FIRST_NAME, fieldValues.get(KFSPropertyConstants.PERSON_FIRST_NAME));
personFieldValues.put(KFSPropertyConstants.PERSON_LAST_NAME, fieldValues.get(KFSPropertyConstants.PERSON_LAST_NAME));
personFieldValues.put(KFSPropertyConstants.EMPLOYEE_ID, fieldValues.get(KFSPropertyConstants.EMPLOYEE_ID));
personFieldValues.put(KFSPropertyConstants.ACTIVE, fieldValues.get(KFSPropertyConstants.ACTIVE));
Map<String, String> fieldConversionMap = disbursementVoucherPayeeService.getFieldConversionBetweenPayeeAndPerson();
this.replaceFieldKeys(personFieldValues, fieldConversionMap);
personFieldValues.put(KIMPropertyConstants.Person.EMPLOYEE_STATUS_CODE, KFSConstants.EMPLOYEE_ACTIVE_STATUS);
return personFieldValues;
}
/**
* Note: This method is not called by validateSearchParameters anymore.
* This method checks if the minimum required fields are filled
*/
public boolean checkMinimumFieldsFilled(Map fieldValues) {
if(StringUtils.isBlank((String) fieldValues.get(KFSPropertyConstants.VENDOR_NUMBER)) && StringUtils.isBlank((String) fieldValues.get(KIMPropertyConstants.Person.EMPLOYEE_ID)) && StringUtils.isBlank((String)fieldValues.get(KIMPropertyConstants.Person.FIRST_NAME)) &&
StringUtils.isBlank((String)fieldValues.get(KIMPropertyConstants.Person.LAST_NAME)) && StringUtils.isBlank((String)fieldValues.get(KFSPropertyConstants.VENDOR_NAME))) {
final String vendorNumberLabel = this.getAttributeLabel(KFSPropertyConstants.VENDOR_NUMBER);
final String vendorNameLabel = this.getAttributeLabel(KFSPropertyConstants.VENDOR_NAME);
final String firstNameLabel = this.getAttributeLabel(KIMPropertyConstants.Person.FIRST_NAME);
final String lastNameLabel = this.getAttributeLabel(KIMPropertyConstants.Person.LAST_NAME);
final String employeeIdLabel = this.getAttributeLabel(KIMPropertyConstants.Person.EMPLOYEE_ID);
GlobalVariables.getMessageMap().putError(KFSPropertyConstants.VENDOR_NUMBER, KFSKeyConstants.ERROR_DV_LOOKUP_NEEDS_SOME_FIELD, new String[] {vendorNumberLabel, employeeIdLabel, vendorNameLabel, firstNameLabel, lastNameLabel});
return false;
}
return true;
}
/**
* Note: This method is not called by validateSearchParameters anymore.
* This method validates the vendor name usage in lookup
*/
public void validateVendorNameUse(Map fieldValues) {
final String vendorName = (String) fieldValues.get(KFSPropertyConstants.VENDOR_NAME);
final String vendorNumber = (String) fieldValues.get(KFSPropertyConstants.VENDOR_NUMBER);
final String employeeId = (String) fieldValues.get(KIMPropertyConstants.Person.EMPLOYEE_ID);
final boolean isVendorInfoEntered = StringUtils.isNotBlank(vendorName) || StringUtils.isNotBlank(vendorNumber);
if (isVendorInfoEntered && StringUtils.isNotBlank(employeeId)) {
// only can use the vendor name and vendor number fields or the employee id field, but not both.
String messageKey = KFSKeyConstants.ERROR_DV_VENDOR_EMPLOYEE_CONFUSION;
String vendorNameLabel = this.getAttributeLabel(KFSPropertyConstants.VENDOR_NAME);
String vendorNumberLabel = this.getAttributeLabel(KFSPropertyConstants.VENDOR_NUMBER);
GlobalVariables.getMessageMap().putError(KIMPropertyConstants.Person.EMPLOYEE_ID, messageKey, this.getAttributeLabel(KIMPropertyConstants.Person.EMPLOYEE_ID), vendorNameLabel, vendorNumberLabel);
}
if (StringUtils.isBlank(vendorNumber) && !StringUtils.isBlank(vendorName) && !filledEnough(vendorName)) {
final String vendorNameLabel = this.getAttributeLabel(KFSPropertyConstants.VENDOR_NAME);
GlobalVariables.getMessageMap().putError(KFSPropertyConstants.VENDOR_NAME, KFSKeyConstants.ERROR_DV_NAME_NOT_FILLED_ENOUGH, new String[] {vendorNameLabel, Integer.toString(getNameLengthWithWildcardRequirement())});
}
}
/**
* Note: This method is not called by validateSearchParameters anymore.
* This method validates the tax criteria
*/
public void validateTaxNumberCriteria(Map fieldValues) {
final String employeeId = (String) fieldValues.get(KIMPropertyConstants.Person.EMPLOYEE_ID);
final String firstName = (String)fieldValues.get(KIMPropertyConstants.Person.FIRST_NAME);
final String lastName = (String)fieldValues.get(KIMPropertyConstants.Person.LAST_NAME);
final String vendorTaxNumber = (String)fieldValues.get(KFSPropertyConstants.TAX_NUMBER);
// we do not use to use Tax Number field for the lookup on the person...
if(StringUtils.isNotBlank(vendorTaxNumber) && StringUtils.isNotBlank(firstName)) {
fieldValues.remove(KFSPropertyConstants.TAX_NUMBER);
String messageKey = KFSKeyConstants.ERROR_DV_LOOKUP_TAX_NUMBER_EMPLOYEE_DETAILS_CONFUSION;
GlobalVariables.getMessageMap().putError(KIMPropertyConstants.Person.FIRST_NAME, messageKey, this.getAttributeLabel(KFSPropertyConstants.TAX_NUMBER), this.getAttributeLabel(KIMPropertyConstants.Person.FIRST_NAME));
}
// if tax number and employee last name entered then send an error message...
if(StringUtils.isNotBlank(vendorTaxNumber) && StringUtils.isNotBlank(lastName)) {
fieldValues.remove(KFSPropertyConstants.TAX_NUMBER);
String messageKey = KFSKeyConstants.ERROR_DV_LOOKUP_TAX_NUMBER_EMPLOYEE_DETAILS_CONFUSION;
GlobalVariables.getMessageMap().putError(KIMPropertyConstants.Person.LAST_NAME, messageKey, this.getAttributeLabel(KFSPropertyConstants.TAX_NUMBER), this.getAttributeLabel(KIMPropertyConstants.Person.LAST_NAME));
}
// if tax number and employee id entered then send an error message...
if(StringUtils.isNotBlank(vendorTaxNumber) && StringUtils.isNotBlank(employeeId)) {
fieldValues.remove(KFSPropertyConstants.TAX_NUMBER);
String messageKey = KFSKeyConstants.ERROR_DV_LOOKUP_TAX_NUMBER_EMPLOYEE_DETAILS_CONFUSION;
GlobalVariables.getMessageMap().putError(KIMPropertyConstants.Person.EMPLOYEE_ID, messageKey, this.getAttributeLabel(KIMPropertyConstants.Person.EMPLOYEE_ID), this.getAttributeLabel(KFSPropertyConstants.TAX_NUMBER));
}
}
/**
* Note: This method is not called by validateSearchParameters anymore.
* This method validates the employee name usage in lookup
*/
public void validateEmployeeNameUse(Map fieldValues) {
final String firstName = (String)fieldValues.get(KIMPropertyConstants.Person.FIRST_NAME);
final String lastName = (String)fieldValues.get(KIMPropertyConstants.Person.LAST_NAME);
final String vendorName = (String) fieldValues.get(KFSPropertyConstants.VENDOR_NAME);
final String employeeId = (String) fieldValues.get(KIMPropertyConstants.Person.EMPLOYEE_ID);
final boolean isPersonNameEntered = StringUtils.isNotBlank(firstName) || StringUtils.isNotBlank(lastName);
if (isPersonNameEntered && StringUtils.isNotBlank(vendorName)) {
// only can use the person first and last name fields or the vendor name field, but not both.
String messageKey = KFSKeyConstants.ERROR_DV_VENDOR_NAME_PERSON_NAME_CONFUSION;
String vendorNameLabel = this.getAttributeLabel(KFSPropertyConstants.VENDOR_NAME);
String firstNameLabel = this.getAttributeLabel(KIMPropertyConstants.Person.FIRST_NAME);
String lastNameLabel = this.getAttributeLabel(KIMPropertyConstants.Person.LAST_NAME);
GlobalVariables.getMessageMap().putError(KFSPropertyConstants.VENDOR_NAME, messageKey, vendorNameLabel, firstNameLabel, lastNameLabel);
}
if (StringUtils.isBlank(employeeId)) {
if (StringUtils.isBlank(firstName) && !StringUtils.isBlank(lastName) && !filledEnough(lastName)) {
final String label = getAttributeLabel(KIMPropertyConstants.Person.LAST_NAME);
GlobalVariables.getMessageMap().putError(KIMPropertyConstants.Person.LAST_NAME, KFSKeyConstants.ERROR_DV_NAME_NOT_FILLED_ENOUGH, new String[] { label, Integer.toString(getNameLengthWithWildcardRequirement() ) } );
} else if (StringUtils.isBlank(lastName) && !StringUtils.isBlank(firstName) && !filledEnough(firstName)) {
final String label = getAttributeLabel(KIMPropertyConstants.Person.FIRST_NAME);
GlobalVariables.getMessageMap().putError(KIMPropertyConstants.Person.FIRST_NAME, KFSKeyConstants.ERROR_DV_NAME_NOT_FILLED_ENOUGH, new String[] { label, Integer.toString(getNameLengthWithWildcardRequirement() ) } );
}
}
}
/**
* @see org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl#performLookup(org.kuali.rice.kns.web.struts.form.LookupForm,
* java.util.Collection, boolean)
*/
@Override
public Collection performLookup(LookupForm lookupForm, Collection resultTable, boolean bounded) {
Map<String, String> fieldValues = lookupForm.getFieldsForLookup();
String paymentReasonCode = fieldValues.get(KFSPropertyConstants.PAYMENT_REASON_CODE);
List<DisbursementPayee> displayList = (List<DisbursementPayee>) super.performLookup(lookupForm, resultTable, bounded);
this.filterReturnUrl((List<ResultRow>) resultTable, displayList, paymentReasonCode);
MessageList messageList = KNSGlobalVariables.getMessageList();
disbursementVoucherPaymentReasonService.postPaymentReasonCodeUsage(paymentReasonCode, messageList);
return displayList;
}
/**
* @see org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl#getSearchResults(java.util.Map)
*/
@Override
public List<? extends BusinessObject> getSearchResults(Map<String, String> fieldValues) {
List<DisbursementPayee> searchResults = new ArrayList<DisbursementPayee>();
if (StringUtils.isNotBlank(fieldValues.get(KFSPropertyConstants.VENDOR_NUMBER)) || StringUtils.isNotBlank(fieldValues.get(KFSPropertyConstants.VENDOR_NAME))) {
searchResults.addAll(this.getVendorsAsPayees(fieldValues));
}
else if (StringUtils.isNotBlank(fieldValues.get(KFSPropertyConstants.EMPLOYEE_ID))) {
searchResults.addAll(this.getPersonAsPayees(fieldValues));
}
else {
searchResults.addAll(this.getVendorsAsPayees(fieldValues));
searchResults.addAll(this.getPersonAsPayees(fieldValues));
}
return sortSearchResults(searchResults);
}
/**
* Sorts search results.
*/
protected List<? extends BusinessObject> sortSearchResults(List<DisbursementPayee> searchResults) {
CollectionIncomplete results = new CollectionIncomplete(searchResults, Long.valueOf(searchResults.size()));
// sort list if default sort column given
List<String> defaultSortColumns = getDefaultSortColumns();
if (defaultSortColumns.size() > 0) {
Collections.sort(results, new BeanPropertyComparator(getDefaultSortColumns(), true));
}
return results;
}
/**
* Determines if a String is "filled enough", i.e. if a wildcard is present, has a length greater than the defined minimum length (3 characters, plus a wildcard).
* @param s the String to test
* @return true if the given String is "filled" by the definition above, false otherwise
*/
protected boolean filledEnough(String s) {
return !containsLookupWildcard(s) || StringUtils.length(s) >= getNameLengthWithWildcardRequirement();
}
/**
* @return the number of characters a name field must be filled in for the search to be valid
*/
protected int getNameLengthWithWildcardRequirement() {
return NAME_REQUIRED_FILLED_WITH_WILDCARD;
}
/**
* Determines if the given String contains a lookup wildcard
* @param s the String to test
* @return true if a lookup wildcard is in the String, false otherwise
*/
protected boolean containsLookupWildcard(String s) {
return StringUtils.contains(s, "*") || StringUtils.contains(s, "%");
}
/**
* perform customer search
*
* @param fieldValues
* @return
*/
protected List<DisbursementPayee> getCustomersAsPayees(Map<String, String> fieldValues) {
List<DisbursementPayee> payeeList = new ArrayList<DisbursementPayee>();
Map<String, String> fieldsForLookup = this.getCustomerFieldValues(fieldValues);
List<AccountsReceivableCustomer> customerList = (List<AccountsReceivableCustomer>) accountsReceivableModuleService.searchForCustomers(fieldsForLookup);
for (AccountsReceivableCustomer customer : customerList) {
DisbursementPayee payee = getPayeeFromCustomer(customer, fieldValues);
payeeList.add(payee);
}
return payeeList;
}
// get the search criteria valid for customer lookup
private Map<String, String> getCustomerFieldValues(Map<String, String> fieldValues) {
Map<String, String> customerFieldValues = new HashMap<String, String>();
customerFieldValues.put(KFSPropertyConstants.CUSTOMER_NUMBER, fieldValues.get(KFSPropertyConstants.CUSTOMER_NUMBER));
customerFieldValues.put(KFSPropertyConstants.CUSTOMER_NAME, fieldValues.get(KFSPropertyConstants.CUSTOMER_NAME));
customerFieldValues.put(KFSPropertyConstants.CUSTOMER_TAX_NUMBER, fieldValues.get(KFSPropertyConstants.TAX_NUMBER));
customerFieldValues.put(KFSPropertyConstants.ACTIVE, fieldValues.get(KFSPropertyConstants.ACTIVE));
return customerFieldValues;
}
/**
*
* @param customer
* @param fieldValues
* @return
*/
protected DisbursementPayee getPayeeFromCustomer(AccountsReceivableCustomer customer, Map<String, String> fieldValues) {
DisbursementPayee payee = DisbursementPayee.getPayeeFromCustomer(customer);
payee.setPaymentReasonCode(fieldValues.get(KFSPropertyConstants.PAYMENT_REASON_CODE));
return payee;
}
/**
* Removes its return URLs if a row is not qualified for returning.
*
* @param resultRowList
* @param payeeList
* @param paymentReasonCode
*/
@Override
protected void filterReturnUrl(List<ResultRow> resultRowList, List<DisbursementPayee> payeeList, String paymentReasonCode) {
Collection<String> payeeTypeCodes = disbursementVoucherPaymentReasonService.getPayeeTypesByPaymentReason(paymentReasonCode);
if (payeeTypeCodes == null || payeeTypeCodes.isEmpty()) {
return;
}
for (int index = 0; index < payeeList.size(); index++) {
DisbursementPayee payee = payeeList.get(index);
boolean isQualified = disbursementVoucherPaymentReasonService.isPayeeQualifiedForPayment(payee, paymentReasonCode, payeeTypeCodes);
if (!isQualified) {
resultRowList.get(index).setReturnUrl(StringUtils.EMPTY);
}
}
}
protected AccountsReceivableModuleService getAccountsReceivableModuleService() {
return accountsReceivableModuleService;
}
public void setAccountsReceivableModuleService(AccountsReceivableModuleService accountsReceivableModuleService) {
this.accountsReceivableModuleService = accountsReceivableModuleService;
}
}