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