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