1 /*
2 * Copyright 2009 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.ole.fp.document.validation.impl;
17
18 import org.kuali.ole.fp.document.CreditCardReceiptDocument;
19 import org.kuali.ole.sys.OLEKeyConstants;
20 import org.kuali.ole.sys.OLEPropertyConstants;
21 import org.kuali.ole.sys.document.validation.GenericValidation;
22 import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
23 import org.kuali.rice.krad.util.GlobalVariables;
24
25 /**
26 * Validation which tests that the amount in credit card lines equals the amount in accounting lines
27 * on the document.
28 */
29 public class CreditCardReceiptDocumentTotalValidation extends GenericValidation {
30 private CreditCardReceiptDocument creditCardReceiptDocumentForValidation;
31
32 /**
33 * For Credit Card Receipt documents, the document is balanced if the sum total of credit card receipts equals the sum total of
34 * the accounting lines.
35 * @see org.kuali.ole.sys.document.validation.Validation#validate(org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent)
36 */
37 public boolean validate(AttributedDocumentEvent event) {
38 // make sure the document is in balance
39 boolean isValid = creditCardReceiptDocumentForValidation.getSourceTotal().equals(creditCardReceiptDocumentForValidation.getTotalDollarAmount());
40
41 if (!isValid) {
42 GlobalVariables.getMessageMap().putError(OLEPropertyConstants.NEW_CREDIT_CARD_RECEIPT, OLEKeyConstants.CreditCardReceipt.ERROR_DOCUMENT_CREDIT_CARD_RECEIPT_OUT_OF_BALANCE);
43 }
44
45 return isValid;
46 }
47
48 /**
49 * Gets the creditCardReceiptDocumentForValidation attribute.
50 * @return Returns the creditCardReceiptDocumentForValidation.
51 */
52 public CreditCardReceiptDocument getCreditCardReceiptDocumentForValidation() {
53 return creditCardReceiptDocumentForValidation;
54 }
55
56 /**
57 * Sets the creditCardReceiptDocumentForValidation attribute value.
58 * @param creditCardReceiptDocumentForValidation The creditCardReceiptDocumentForValidation to set.
59 */
60 public void setCreditCardReceiptDocumentForValidation(CreditCardReceiptDocument creditCardReceiptDocumentForValidation) {
61 this.creditCardReceiptDocumentForValidation = creditCardReceiptDocumentForValidation;
62 }
63
64 }