001/**
002 * Copyright 2005-2016 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
025            tabs which will appear on the document.
026 *
027 *                The headerNavigationTab defines an additional tab which
028                will appear on the document.
029
030 */
031@Deprecated
032public class HeaderNavigation extends DataDictionaryDefinitionBase implements Serializable {
033    private static final long serialVersionUID = 4317341111287854436L;
034    
035        protected String headerTabMethodToCall;
036    protected String headerTabNavigateTo;
037    protected String headerTabDisplayName;
038    protected HelpDefinition helpDefinition;
039    protected boolean disabled = false;
040    
041    public HeaderNavigation() {}
042
043    public HeaderNavigation(String headerTabNavigateTo, String headerTabDisplayName) {
044        this.headerTabNavigateTo = headerTabNavigateTo;
045        this.headerTabDisplayName = headerTabDisplayName;
046    }
047
048    /**
049     * Gets the navigationKey attribute.
050     * 
051     * @return Returns the navigationKey.
052     */
053    public String getHeaderTabMethodToCall() {
054        return headerTabMethodToCall;
055    }
056
057    /**
058     * Sets the navigationKey attribute value.
059     * 
060     * @param navigationKey The navigationKey to set.
061     */
062    public void setHeaderTabMethodToCall(String navigationKey) {
063        this.headerTabMethodToCall = navigationKey;
064    }
065
066    /**
067     * Gets the navigationStyle attribute.
068     * 
069     * @return Returns the navigationStyle.
070     */
071    public String getHeaderTabDisplayName() {
072        return headerTabDisplayName;
073    }
074
075    /**
076     * The displayName element is the name of the additional tab.
077     */
078    public void setHeaderTabDisplayName(String headerTabDisplayName) {
079        this.headerTabDisplayName = headerTabDisplayName;
080    }
081
082    /**
083     * Gets the suffix attribute.
084     * 
085     * @return Returns the suffix.
086     */
087    public String getHeaderTabNavigateTo() {
088        return headerTabNavigateTo;
089    }
090    
091    public HelpDefinition getHelpDefinition() {
092        return helpDefinition;
093    }
094
095    /**
096     * The pageHelp element provides the keys to
097                    obtain a help description from the database.
098
099                    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        this.helpDefinition = helpDefinition;
109    }
110
111    /**
112     * The navigateTo element is the forward name in the struts-config file.
113     */
114    public void setHeaderTabNavigateTo(String suffix) {
115        this.headerTabNavigateTo = suffix;
116    }
117
118    public boolean isDisabled() {
119        return disabled;
120    }
121
122    public void setDisabled(boolean disabled) {
123        this.disabled = disabled;
124    }
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    }
133}