001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kns.datadictionary;
017
018import org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase;
019import org.kuali.rice.krad.datadictionary.HelpDefinition;
020
021import java.io.Serializable;
022
023/**
024 * The headerNavigation element defines a set of additional tabs which will appear on the document.
025 *
026 * The headerNavigationTab defines an additional tab which will appear on the document.
027 *
028 * @@deprecated Only used in KNS classes, use KRAD.
029 */
030@Deprecated
031public class HeaderNavigation extends DataDictionaryDefinitionBase implements Serializable {
032    private static final long serialVersionUID = 4317341111287854436L;
033    
034        protected String headerTabMethodToCall;
035    protected String headerTabNavigateTo;
036    protected String headerTabDisplayName;
037    protected HelpDefinition helpDefinition;
038    protected boolean disabled = false;
039    
040    public HeaderNavigation() {}
041
042    public HeaderNavigation(String headerTabNavigateTo, String headerTabDisplayName) {
043        this.headerTabNavigateTo = headerTabNavigateTo;
044        this.headerTabDisplayName = headerTabDisplayName;
045    }
046
047    /**
048     * Gets the navigationKey attribute.
049     * 
050     * @return Returns the navigationKey.
051     */
052    public String getHeaderTabMethodToCall() {
053        return headerTabMethodToCall;
054    }
055
056    /**
057     * Sets the navigationKey attribute value.
058     * 
059     * @param navigationKey The navigationKey to set.
060     */
061    public void setHeaderTabMethodToCall(String navigationKey) {
062        this.headerTabMethodToCall = navigationKey;
063    }
064
065    /**
066     * Gets the navigationStyle attribute.
067     * 
068     * @return Returns the navigationStyle.
069     */
070    public String getHeaderTabDisplayName() {
071        return headerTabDisplayName;
072    }
073
074    /**
075     * The displayName element is the name of the additional tab.
076     */
077    public void setHeaderTabDisplayName(String headerTabDisplayName) {
078        this.headerTabDisplayName = headerTabDisplayName;
079    }
080
081    /**
082     * Gets the suffix attribute.
083     * 
084     * @return Returns the suffix.
085     */
086    public String getHeaderTabNavigateTo() {
087        return headerTabNavigateTo;
088    }
089    
090    public HelpDefinition getHelpDefinition() {
091        return helpDefinition;
092    }
093
094    /**
095     * The pageHelp element provides the keys to
096                    obtain a help description from the database.
097
098                    On document JSP pages, a help icon may be rendered.  If this tag is specified, then
099                    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}