1 /**
2 * Copyright 2005-2016 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.krad.datadictionary.DataDictionaryDefinitionBase;
19 import org.kuali.rice.krad.datadictionary.HelpDefinition;
20
21 import java.io.Serializable;
22
23 /**
24 * The headerNavigation element defines a set of additional tabs which will appear on the document.
25 *
26 * The headerNavigationTab defines an additional tab which will appear on the document.
27 *
28 * @@deprecated Only used in KNS classes, use KRAD.
29 */
30 @Deprecated
31 public class HeaderNavigation extends DataDictionaryDefinitionBase implements Serializable {
32 private static final long serialVersionUID = 4317341111287854436L;
33
34 protected String headerTabMethodToCall;
35 protected String headerTabNavigateTo;
36 protected String headerTabDisplayName;
37 protected HelpDefinition helpDefinition;
38 protected boolean disabled = false;
39
40 public HeaderNavigation() {}
41
42 public HeaderNavigation(String headerTabNavigateTo, String headerTabDisplayName) {
43 this.headerTabNavigateTo = headerTabNavigateTo;
44 this.headerTabDisplayName = headerTabDisplayName;
45 }
46
47 /**
48 * Gets the navigationKey attribute.
49 *
50 * @return Returns the navigationKey.
51 */
52 public String getHeaderTabMethodToCall() {
53 return headerTabMethodToCall;
54 }
55
56 /**
57 * Sets the navigationKey attribute value.
58 *
59 * @param navigationKey The navigationKey to set.
60 */
61 public void setHeaderTabMethodToCall(String navigationKey) {
62 this.headerTabMethodToCall = navigationKey;
63 }
64
65 /**
66 * Gets the navigationStyle attribute.
67 *
68 * @return Returns the navigationStyle.
69 */
70 public String getHeaderTabDisplayName() {
71 return headerTabDisplayName;
72 }
73
74 /**
75 * The displayName element is the name of the additional tab.
76 */
77 public void setHeaderTabDisplayName(String headerTabDisplayName) {
78 this.headerTabDisplayName = headerTabDisplayName;
79 }
80
81 /**
82 * Gets the suffix attribute.
83 *
84 * @return Returns the suffix.
85 */
86 public String getHeaderTabNavigateTo() {
87 return headerTabNavigateTo;
88 }
89
90 public HelpDefinition getHelpDefinition() {
91 return helpDefinition;
92 }
93
94 /**
95 * The pageHelp element provides the keys to
96 obtain a help description from the database.
97
98 On document JSP pages, a help icon may be rendered. If this tag is specified, then
99 the filename of this page will be located in the value of the parameter specified by the namespace, detail type, and name.
100
101 The value of the parameter is relative to the value of the "externalizable.help.url" property in ConfigurationService (see KualiHelpAction).
102 parameterNamespace: namespace of the parameter that has the path to the help page
103 parameterName: name of the parameter that has the path to the help page
104 parameterDetailType: detail type of the parameter that has the path to the help page
105 */
106 public void setHelpDefinition(HelpDefinition helpDefinition) {
107 this.helpDefinition = helpDefinition;
108 }
109
110 /**
111 * The navigateTo element is the forward name in the struts-config file.
112 */
113 public void setHeaderTabNavigateTo(String suffix) {
114 this.headerTabNavigateTo = suffix;
115 }
116
117 public boolean isDisabled() {
118 return disabled;
119 }
120
121 public void setDisabled(boolean disabled) {
122 this.disabled = disabled;
123 }
124
125 /**
126 * @see org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Class)
127 */
128 public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {
129 // No real validation to be done here other than perhaps checking to be
130 // sure that the security workgroup is a valid workgroup.
131 }
132 }