View Javadoc

1   /*
2    * Copyright 2008 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.sys.document.datadictionary;
17  
18  import java.util.Map;
19  
20  import org.kuali.ole.sys.businessobject.AccountingLineParser;
21  import org.kuali.rice.kns.datadictionary.TransactionalDocumentEntry;
22  
23  /**
24   * An extension of the Rice TransactionalDocumentEntry that allows for OLE-centric properties, such as
25   * Accounting Document validations 
26   */
27  public class FinancialSystemTransactionalDocumentEntry extends TransactionalDocumentEntry {
28      private Map<Class, String> validationMap;
29      private Map<String, AccountingLineGroupDefinition> accountingLineGroups;
30      private Class<? extends AccountingLineParser> importedLineParserClass;
31      private Integer maxDictionaryValidationDepth;
32      protected boolean allowsErrorCorrection = false;
33      protected boolean potentiallySensitive = false;
34  
35      /**
36       * Gets the validationMap attribute. 
37       * @return Returns the validationMap.
38       */
39      public Map<Class, String> getValidationMap() {
40          return validationMap;
41      }
42  
43      /**
44       * Sets the validationMap attribute value.
45       * @param validationMap The validationMap to set.
46       */
47      public void setValidationMap(Map<Class, String> validationMap) {
48          this.validationMap = validationMap;
49      }
50  
51      /**
52       * Gets the accountingLineGroups attribute. 
53       * @return Returns the accountingLineGroups.
54       */
55      public Map<String, AccountingLineGroupDefinition> getAccountingLineGroups() {
56          return accountingLineGroups;
57      }
58  
59      /**
60       * Sets the accountingLineGroups attribute value.
61       * @param accountingLineGroups The accountingLineGroups to set.
62       */
63      public void setAccountingLineGroups(Map<String, AccountingLineGroupDefinition> accountingLineGroups) {
64          this.accountingLineGroups = accountingLineGroups;
65      }
66      
67      /**
68       * Gets the importedLineParserClass attribute. 
69       * @return Returns the importedLineParserClass.
70       */
71      public Class<? extends AccountingLineParser> getImportedLineParserClass() {
72          return importedLineParserClass;
73      }
74  
75      /**
76       * Sets the importedLineParserClass attribute value.
77       * @param importedLineParserClass The importedLineParserClass to set.
78       */
79      public void setImportedLineParserClass(Class<? extends AccountingLineParser> importedLineParser) {
80          this.importedLineParserClass = importedLineParser;
81      }
82  
83      /**
84       * Gets the maxDictionaryValidationDepth attribute. 
85       * @return Returns the maxDictionaryValidationDepth.
86       */
87      public Integer getMaxDictionaryValidationDepth() {
88          return maxDictionaryValidationDepth;
89      }
90  
91      /**
92       * Sets the maxDictionaryValidationDepth attribute value.
93       * @param maxDictionaryValidationDepth The maxDictionaryValidationDepth to set.
94       */
95      public void setMaxDictionaryValidationDepth(Integer maxDictionaryValidationDepth) {
96          this.maxDictionaryValidationDepth = maxDictionaryValidationDepth;
97      }
98      
99      /**
100         This field contains a value of true or false.
101         If true, then error correction is allowed for the document.
102      */
103     public void setAllowsErrorCorrection(boolean allowsErrorCorrection) {
104         this.allowsErrorCorrection = allowsErrorCorrection;
105     }
106     
107     /**
108      * 
109      * @see org.kuali.rice.kns.datadictionary.TransactionalDocumentEntry#getAllowsErrorCorrection()
110      */
111     public boolean getAllowsErrorCorrection() {
112         return allowsErrorCorrection;
113     }
114 
115     /**
116      * Gets the potentiallySensitive attribute. 
117      * @return Returns the potentiallySensitive.
118      */
119     public boolean isPotentiallySensitive() {
120         return potentiallySensitive;
121     }
122 
123     /**
124      * Sets the potentiallySensitive attribute value.
125      * @param potentiallySensitive The potentiallySensitive to set.
126      */
127     public void setPotentiallySensitive(boolean potentiallySensitive) {
128         this.potentiallySensitive = potentiallySensitive;
129     }
130     
131     
132 }