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