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