View Javadoc
1   /**
2    * Copyright 2005-2011 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.rice.kns.datadictionary;
17  
18  import org.kuali.rice.kns.rule.PromptBeforeValidation;
19  import org.kuali.rice.kns.web.derivedvaluesetter.DerivedValuesSetter;
20  import org.kuali.rice.krad.document.authorization.DocumentAuthorizer;
21  import org.kuali.rice.krad.document.authorization.DocumentPresentationController;
22  
23  import java.util.ArrayList;
24  import java.util.List;
25  
26  /**
27   * @author Kuali Rice Team (rice.collab@kuali.org)
28   */
29  @Deprecated
30  public class DocumentEntry extends org.kuali.rice.krad.datadictionary.DocumentEntry implements KNSDocumentEntry {
31  
32      protected Class<? extends PromptBeforeValidation> promptBeforeValidationClass;
33      protected Class<? extends DerivedValuesSetter> derivedValuesSetterClass;
34      protected List<String> webScriptFiles = new ArrayList<String>(3);
35      protected List<HeaderNavigation> headerNavigationList = new ArrayList<HeaderNavigation>();
36  
37      protected boolean sessionDocument = false;
38  
39      @Override
40      public List<HeaderNavigation> getHeaderNavigationList() {
41          return headerNavigationList;
42      }
43  
44      @Override
45      public List<String> getWebScriptFiles() {
46          return webScriptFiles;
47      }
48  
49      /**
50       * @return Returns the preRulesCheckClass.
51       */
52      @Override
53      public Class<? extends PromptBeforeValidation> getPromptBeforeValidationClass() {
54          return promptBeforeValidationClass;
55      }
56  
57      /**
58       * The promptBeforeValidationClass element is the full class name of the java
59       * class which determines whether the user should be asked any questions prior to running validation.
60       *
61       * @see KualiDocumentActionBase#promptBeforeValidation(org.apache.struts.action.ActionMapping,
62       *      org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest,
63       *      javax.servlet.http.HttpServletResponse, String)
64       */
65      @Override
66      public void setPromptBeforeValidationClass(Class<? extends PromptBeforeValidation> preRulesCheckClass) {
67          this.promptBeforeValidationClass = preRulesCheckClass;
68      }
69  
70      /**
71       * The webScriptFile element defines the name of javascript files
72       * that are necessary for processing the document.  The specified
73       * javascript files will be included in the generated html.
74       */
75      @Override
76      public void setWebScriptFiles(List<String> webScriptFiles) {
77          this.webScriptFiles = webScriptFiles;
78      }
79  
80      /**
81       * The headerNavigation element defines a set of additional
82       * tabs which will appear on the document.
83       */
84      @Override
85      public void setHeaderNavigationList(List<HeaderNavigation> headerNavigationList) {
86          this.headerNavigationList = headerNavigationList;
87      }
88  
89      @Override
90      public boolean isSessionDocument() {
91          return this.sessionDocument;
92      }
93  
94      @Override
95      public void setSessionDocument(boolean sessionDocument) {
96          this.sessionDocument = sessionDocument;
97      }
98  
99      /**
100      * @return the derivedValuesSetter
101      */
102     @Override
103     public Class<? extends DerivedValuesSetter> getDerivedValuesSetterClass() {
104         return this.derivedValuesSetterClass;
105     }
106 
107     /**
108      * @param derivedValuesSetter the derivedValuesSetter to set
109      */
110     @Override
111     public void setDerivedValuesSetterClass(Class<? extends DerivedValuesSetter> derivedValuesSetter) {
112         this.derivedValuesSetterClass = derivedValuesSetter;
113     }
114 }