/*
* 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.module.ar.businessobject;
import java.sql.Date;
import java.util.LinkedHashMap;
import org.apache.commons.lang.StringUtils;
import org.kuali.kfs.module.ar.document.CashControlDocument;
import org.kuali.kfs.module.ar.document.PaymentApplicationDocument;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.rice.core.api.util.type.KualiDecimal;
import org.kuali.rice.kew.api.exception.WorkflowException;
import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
import org.kuali.rice.krad.service.DocumentService;
import org.kuali.rice.krad.util.ObjectUtils;
/**
* @author Kuali Nervous System Team (kualidev@oncourse.iu.edu)
*/
public class CashControlDetail extends PersistableBusinessObjectBase {
private String documentNumber;
private String referenceFinancialDocumentNumber;
private String customerPaymentMediumIdentifier;
private KualiDecimal financialDocumentLineAmount;
private String customerPaymentDescription;
private String customerNumber;
private String status;
private Date customerPaymentDate;
private transient PaymentApplicationDocument referenceFinancialDocument;
private transient CashControlDocument cashControlDocument;
private Customer customer;
/**
* Default constructor.
*/
public CashControlDetail() {
financialDocumentLineAmount = new KualiDecimal(0);
}
/**
* Gets the documentNumber attribute.
*
* @return Returns the documentNumber
*
*/
public String getDocumentNumber() {
return documentNumber;
}
/**
* Sets the documentNumber attribute.
*
* @param documentNumber The documentNumber to set.
*
*/
public void setDocumentNumber(String documentNumber) {
this.documentNumber = documentNumber;
}
/**
* Gets the referenceFinancialDocumentNumber attribute.
*
* @return Returns the referenceFinancialDocumentNumber
*
*/
public String getReferenceFinancialDocumentNumber() {
return referenceFinancialDocumentNumber;
}
/**
* Sets the referenceFinancialDocumentNumber attribute.
*
* @param referenceFinancialDocumentNumber The referenceFinancialDocumentNumber to set.
*/
public void setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber) {
this.referenceFinancialDocumentNumber = referenceFinancialDocumentNumber;
}
/**
* Gets the customerPaymentMediumIdentifier attribute.
*
* @return Returns the customerPaymentMediumIdentifier
*
*/
public String getCustomerPaymentMediumIdentifier() {
return customerPaymentMediumIdentifier;
}
/**
* Sets the customerPaymentMediumIdentifier attribute.
*
* @param customerPaymentMediumIdentifier The customerPaymentMediumIdentifier to set.
*
*/
public void setCustomerPaymentMediumIdentifier(String customerPaymentMediumIdentifier) {
this.customerPaymentMediumIdentifier = customerPaymentMediumIdentifier;
}
/**
* Gets the financialDocumentLineAmount attribute.
*
* @return Returns the financialDocumentLineAmount
*
*/
public KualiDecimal getFinancialDocumentLineAmount() {
return financialDocumentLineAmount;
}
/**
* Sets the financialDocumentLineAmount attribute.
*
* @param financialDocumentLineAmount The financialDocumentLineAmount to set.
*
*/
public void setFinancialDocumentLineAmount(KualiDecimal financialDocumentLineAmount) {
this.financialDocumentLineAmount = financialDocumentLineAmount;
}
/**
* Gets the customerPaymentDescription attribute.
*
* @return Returns the customerPaymentDescription
*
*/
public String getCustomerPaymentDescription() {
return customerPaymentDescription;
}
/**
* Sets the customerPaymentDescription attribute.
*
* @param customerPaymentDescription The customerPaymentDescription to set.
*
*/
public void setCustomerPaymentDescription(String customerPaymentDescription) {
this.customerPaymentDescription = customerPaymentDescription;
}
/**
* Gets the customerNumber attribute.
*
* @return Returns the customerNumber
*
*/
public String getCustomerNumber() {
return customerNumber;
}
/**
* Sets the customerNumber attribute.
*
* @param customerNumber The customerNumber to set.
*
*/
public void setCustomerNumber(String customerNumber) {
this.customerNumber = customerNumber;
}
/**
* Gets the customerPaymentDate attribute.
*
* @return Returns the customerPaymentDate
*
*/
public Date getCustomerPaymentDate() {
return customerPaymentDate;
}
/**
* Sets the customerPaymentDate attribute.
*
* @param customerPaymentDate The customerPaymentDate to set.
*
*/
public void setCustomerPaymentDate(Date customerPaymentDate) {
this.customerPaymentDate = customerPaymentDate;
}
/**
* Gets the referenceFinancialDocument attribute.
*
* @return Returns the referenceFinancialDocument
*
*/
public PaymentApplicationDocument getReferenceFinancialDocument() {
//This is to add NP checking on referenceFinancialDocumentNumber
if (ObjectUtils.isNull(referenceFinancialDocument) && StringUtils.isNotEmpty(referenceFinancialDocumentNumber)) {
try {
referenceFinancialDocument = (PaymentApplicationDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(this.referenceFinancialDocumentNumber);
}
catch (WorkflowException e) {
throw new RuntimeException("WorkflowException caught while trying to load PayApp Document #" + referenceFinancialDocumentNumber + ".", e);
}
}
return referenceFinancialDocument;
}
/**
* Sets the referenceFinancialDocument attribute.
*
* @param referenceFinancialDocument The referenceFinancialDocument to set.
*
*/
public void setReferenceFinancialDocument(PaymentApplicationDocument referenceFinancialDocument) {
this.referenceFinancialDocument = referenceFinancialDocument;
}
/**
* Gets the customer attribute.
*
* @return Returns the customer
*
*/
public Customer getCustomer() {
return customer;
}
/**
* Sets the customer attribute.
*
* @param customer The customer to set.
* @deprecated
*/
@Deprecated
public void setCustomer(Customer customer) {
this.customer = customer;
}
/**
* @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
*/
@SuppressWarnings("unchecked")
protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
LinkedHashMap m = new LinkedHashMap();
m.put("documentNumber", this.documentNumber);
m.put("referenceFinancialDocumentNumber", this.referenceFinancialDocumentNumber);
return m;
}
public CashControlDocument getCashControlDocument() {
if (cashControlDocument == null) {
try {
String n = getDocumentNumber();
if(null == n) {
return null;
}
cashControlDocument = (CashControlDocument) SpringContext.getBean(DocumentService.class).getByDocumentHeaderId(n);
}
catch (WorkflowException e) {
throw new RuntimeException("WorkflowException caught while trying to load CashControl Document #" + referenceFinancialDocumentNumber + ".", e);
}
}
return cashControlDocument;
}
public void setCashControlDocument(CashControlDocument cashControlDocument) {
this.cashControlDocument = cashControlDocument;
}
/**
* This method gets cash control detail status
* @return cash control detail status
*/
public String getStatus() {
return status;
}
/**
* This method sets cash control detail status
* @param status
*/
public void setStatus(String status) {
this.status = status;
}
}