View Javadoc
1   /*
2    * Copyright 2006 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.web.struts;
17  
18  import org.kuali.ole.sys.OLEConstants;
19  import org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase;
20  import org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase;
21  import org.kuali.rice.krad.util.KRADConstants;
22  
23  /**
24   * This class is the struts base form for financial form documents that need
25   * capital accounting lines.
26   */
27  public abstract class CapitalAssetInformationFormBase extends KualiAccountingDocumentFormBase {
28      protected static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(KualiAccountingDocumentActionBase.class);
29  
30      // Indicates which result set we are using when refreshing/returning from a multi-value lookup.
31      protected String lookupResultsSequenceNumber;
32  
33      // Type of result returned by the multi-value lookup. ?to be persisted in the lookup results service instead?
34      protected String lookupResultsBOClassName;
35  
36      // The name of the collection looked up (by a multiple value lookup)
37      protected String lookedUpCollectionName;
38  
39      /**
40       * Constructs a AdvanceDepositForm.java.
41       */
42      public CapitalAssetInformationFormBase() {
43          super();
44      }
45     
46      /**
47       * Gets the lookupResultsSequenceNumber attribute.
48       * 
49       * @return Returns the lookupResultsSequenceNumber
50       */
51      
52      public String getLookupResultsSequenceNumber() {
53          return lookupResultsSequenceNumber;
54      }
55  
56      /** 
57       * Sets the lookupResultsSequenceNumber attribute.
58       * 
59       * @param lookupResultsSequenceNumber The lookupResultsSequenceNumber to set.
60       */
61      public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber) {
62          this.lookupResultsSequenceNumber = lookupResultsSequenceNumber;
63      }
64  
65      /**
66       * Gets the lookupResultsBOClassName attribute.
67       * 
68       * @return Returns the lookupResultsBOClassName
69       */
70      
71      public String getLookupResultsBOClassName() {
72          return lookupResultsBOClassName;
73      }
74  
75      /** 
76       * Sets the lookupResultsBOClassName attribute.
77       * 
78       * @param lookupResultsBOClassName The lookupResultsBOClassName to set.
79       */
80      public void setLookupResultsBOClassName(String lookupResultsBOClassName) {
81          this.lookupResultsBOClassName = lookupResultsBOClassName;
82      }
83  
84      /**
85       * Gets the lookedUpCollectionName attribute.
86       * 
87       * @return Returns the lookedUpCollectionName
88       */
89      
90      public String getLookedUpCollectionName() {
91          return lookedUpCollectionName;
92      }
93  
94      /** 
95       * Sets the lookedUpCollectionName attribute.
96       * 
97       * @param lookedUpCollectionName The lookedUpCollectionName to set.
98       */
99      public void setLookedUpCollectionName(String lookedUpCollectionName) {
100         this.lookedUpCollectionName = lookedUpCollectionName;
101     }
102 
103     /**
104      * @see org.kuali.rice.kns.web.struts.form.AccountingDocumentFormBase#getRefreshCaller()
105      */
106     @Override
107     public String getRefreshCaller() {
108         return OLEConstants.MULTIPLE_VALUE;
109     }
110 
111     /**
112      * @see org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase#addRequiredNonEditableProperties()
113      */
114     @Override
115     public void addRequiredNonEditableProperties() {
116         super.addRequiredNonEditableProperties();
117         registerRequiredNonEditableProperty(KRADConstants.LOOKUP_RESULTS_SEQUENCE_NUMBER);
118     }
119 }