001/*
002 * Copyright 2006 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
017package org.kuali.ole.fp.businessobject;
018
019import java.sql.Timestamp;
020import java.util.LinkedHashMap;
021
022import org.kuali.ole.fp.document.CashReceiptDocument;
023import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
024
025/**
026 * This class represents a deposit cash receipt control which contains cash receipt header used for validating receipts
027 */
028public class DepositCashReceiptControl extends PersistableBusinessObjectBase {
029    private String financialDocumentDepositNumber;
030    private Integer financialDocumentDepositLineNumber;
031    private String financialDocumentCashReceiptNumber;
032
033    private Timestamp financialSystemsCashReceiptProcessingTimestamp;
034    private String financialSystemsProcessingOperatorIdentifier;
035
036    private Deposit deposit;
037    private CashReceiptDocument cashReceiptDocument;
038
039
040    /**
041     * Default constructor.
042     */
043    public DepositCashReceiptControl() {
044
045    }
046
047    /**
048     * Gets the cashReceiptDocument attribute. 
049     * @return Returns the cashReceiptDocument.
050     */
051    public CashReceiptDocument getCashReceiptDocument() {
052        return cashReceiptDocument;
053    }
054
055    /**
056     * Sets the cashReceiptDocument attribute value.
057     * @param cashReceiptDocument The cashReceiptDocument to set.
058     */
059    public void setCashReceiptDocument(CashReceiptDocument cashReceiptDocument) {
060        this.cashReceiptDocument = cashReceiptDocument;
061    }
062
063
064
065    /**
066     * @return current value of deposit.
067     */
068    public Deposit getDeposit() {
069        return deposit;
070    }
071
072    /**
073     * Sets the deposit attribute value.
074     * 
075     * @param deposit The deposit to set.
076     */
077    public void setDeposit(Deposit deposit) {
078        this.deposit = deposit;
079    }
080
081
082    /**
083     * @return current value of financialDocumentCashReceiptNumber.
084     */
085    public String getFinancialDocumentCashReceiptNumber() {
086        return financialDocumentCashReceiptNumber;
087    }
088
089    /**
090     * Sets the financialDocumentCashReceiptNumber attribute value.
091     * 
092     * @param financialDocumentCashReceiptNumber The financialDocumentCashReceiptNumber to set.
093     */
094    public void setFinancialDocumentCashReceiptNumber(String financialDocumentCashReceiptNumber) {
095        this.financialDocumentCashReceiptNumber = financialDocumentCashReceiptNumber;
096    }
097
098
099    /**
100     * @return current value of financialDocumentDepositNumber.
101     */
102    public String getFinancialDocumentDepositNumber() {
103        return financialDocumentDepositNumber;
104    }
105
106    /**
107     * Sets the financialDocumentDepositNumber attribute value.
108     * 
109     * @param financialDocumentDepositNumber The financialDocumentDepositNumber to set.
110     */
111    public void setFinancialDocumentDepositNumber(String financialDocumentDepositNumber) {
112        this.financialDocumentDepositNumber = financialDocumentDepositNumber;
113    }
114
115
116    /**
117     * @return current value of financialDocumentDepositLineNumber.
118     */
119    public Integer getFinancialDocumentDepositLineNumber() {
120        return financialDocumentDepositLineNumber;
121    }
122
123    /**
124     * Sets the financialDocumentDepositLineNumber attribute value.
125     * 
126     * @param financialDocumentDepositLineNumber The financialDocumentDepositLineNumber to set.
127     */
128    public void setFinancialDocumentDepositLineNumber(Integer financialDocumentDepositLineNumber) {
129        this.financialDocumentDepositLineNumber = financialDocumentDepositLineNumber;
130    }
131
132
133    /**
134     * @return current value of financialSystemsCashReceiptProcessingTimestamp.
135     */
136    public Timestamp getFinancialSystemsCashReceiptProcessingTimestamp() {
137        return financialSystemsCashReceiptProcessingTimestamp;
138    }
139
140    /**
141     * Sets the financialSystemsCashReceiptProcessingTimestamp attribute value.
142     * 
143     * @param financialSystemsCashReceiptProcessingTimestamp The financialSystemsCashReceiptProcessingTimestamp to set.
144     */
145    public void setFinancialSystemsCashReceiptProcessingTimestamp(Timestamp financialSystemsCashReceiptProcessingTimestamp) {
146        this.financialSystemsCashReceiptProcessingTimestamp = financialSystemsCashReceiptProcessingTimestamp;
147    }
148
149
150    /**
151     * @return current value of financialSystemsProcessingOperatorIdentifier.
152     */
153    public String getFinancialSystemsProcessingOperatorIdentifier() {
154        return financialSystemsProcessingOperatorIdentifier;
155    }
156
157    /**
158     * Sets the financialSystemsProcessingOperatorIdentifier attribute value.
159     * 
160     * @param financialSystemsProcessingOperatorIdentifier The financialSystemsProcessingOperatorIdentifier to set.
161     */
162    public void setFinancialSystemsProcessingOperatorIdentifier(String financialSystemsProcessingOperatorIdentifier) {
163        this.financialSystemsProcessingOperatorIdentifier = financialSystemsProcessingOperatorIdentifier;
164    }
165
166
167    /**
168     * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
169     */
170    protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
171        LinkedHashMap m = new LinkedHashMap();
172        m.put("financialDocumentDepositNumber", getFinancialDocumentDepositNumber());
173        m.put("financialDocumentDepositLineNumber", getFinancialDocumentDepositLineNumber());
174        m.put("financialDocumentCashReceiptNumber", getFinancialDocumentCashReceiptNumber());
175        return m;
176    }
177}