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