01: /*
02: * Copyright 2006-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.gl.service;
17:
18: import java.util.List;
19:
20: import org.kuali.kfs.bo.GeneralLedgerPendingEntry;
21: import org.kuali.module.gl.bo.OriginEntry;
22: import org.kuali.module.gl.bo.UniversityDate;
23: import org.kuali.module.gl.util.Message;
24:
25: /**
26: * An interface that declares methods that would be needed to validate origin entries and transactions run through the scrubber
27: */
28: public interface ScrubberValidator {
29: /**
30: * Validate a transaction in the scrubber
31: *
32: * @param originEntry Input transaction (never changed)
33: * @param scrubbedEntry Output transaction (scrubbed version of input transaction)
34: * @param universityRunDate Date of scrubber run
35: * @return List of Message objects based for warnings or errors that happened when validating the transaction
36: */
37: public List<Message> validateTransaction(OriginEntry originEntry,
38: OriginEntry scrubbedEntry,
39: UniversityDate universityRunDate, boolean laborIndicator);
40:
41: /**
42: * Validate a transaction for use in balance inquiry
43: *
44: * @param entry Input transaction
45: */
46: public void validateForInquiry(GeneralLedgerPendingEntry entry);
47:
48: /**
49: * This method gives the scrubber step a way to populate the origin entry lookup service on validators that need it
50: *
51: * @param originEntryableLookupService
52: */
53: public void setReferenceLookup(
54: OriginEntryLookupService originEntryLookupService);
55: }
|