org.kuali.rice.kns.datadictionary

Class HeaderNavigation

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.kns.datadictionary.HeaderNavigation

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean

Deprecated.

@Deprecated
public class HeaderNavigation
extends DataDictionaryDefinitionBase
implements Serializable

The headerNavigation element defines a set of additional tabs which will appear on the document. The headerNavigationTab defines an additional tab which will appear on the document.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	disabled Deprecated.
protected String	headerTabDisplayName Deprecated.
protected String	headerTabMethodToCall Deprecated.
protected String	headerTabNavigateTo Deprecated.
protected HelpDefinition	helpDefinition Deprecated.

Fields inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

embeddedDataObjectMetadata, generatedFromMetadata, id

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
HeaderNavigation() Deprecated.
HeaderNavigation(String headerTabNavigateTo, String headerTabDisplayName) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Deprecated. Default implementation so that all subclasses do not need to implement this deprecated method.
String	getHeaderTabDisplayName() Deprecated. Gets the navigationStyle attribute.
String	getHeaderTabMethodToCall() Deprecated. Gets the navigationKey attribute.
String	getHeaderTabNavigateTo() Deprecated. Gets the suffix attribute.
HelpDefinition	getHelpDefinition() Deprecated.
boolean	isDisabled() Deprecated.
void	setDisabled(boolean disabled) Deprecated.
void	setHeaderTabDisplayName(String headerTabDisplayName) Deprecated. The displayName element is the name of the additional tab.
void	setHeaderTabMethodToCall(String navigationKey) Deprecated. Sets the navigationKey attribute value.
void	setHeaderTabNavigateTo(String suffix) Deprecated. The navigateTo element is the forward name in the struts-config file.
void	setHelpDefinition(HelpDefinition helpDefinition) Deprecated. The pageHelp element provides the keys to obtain a help description from the database.

Methods inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

completeValidation, getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

headerTabMethodToCall

protected String headerTabMethodToCall

Deprecated.

headerTabNavigateTo

protected String headerTabNavigateTo

Deprecated.

headerTabDisplayName

protected String headerTabDisplayName

Deprecated.

helpDefinition

protected HelpDefinition helpDefinition

Deprecated.

disabled

protected boolean disabled

Deprecated.

Constructor Detail

HeaderNavigation

public HeaderNavigation()

Deprecated.

HeaderNavigation

public HeaderNavigation(String headerTabNavigateTo,
                String headerTabDisplayName)

Deprecated.

Method Detail

getHeaderTabMethodToCall

public String getHeaderTabMethodToCall()

Deprecated.

Gets the navigationKey attribute.

Returns:

Returns the navigationKey.

setHeaderTabMethodToCall

public void setHeaderTabMethodToCall(String navigationKey)

Deprecated.

Sets the navigationKey attribute value.

Parameters:

navigationKey - The navigationKey to set.

getHeaderTabDisplayName

public String getHeaderTabDisplayName()

Deprecated.

Gets the navigationStyle attribute.

Returns:

Returns the navigationStyle.

setHeaderTabDisplayName

public void setHeaderTabDisplayName(String headerTabDisplayName)

Deprecated.

The displayName element is the name of the additional tab.

getHeaderTabNavigateTo

public String getHeaderTabNavigateTo()

Deprecated.

Gets the suffix attribute.

Returns:

Returns the suffix.

getHelpDefinition

public HelpDefinition getHelpDefinition()

Deprecated.

setHelpDefinition

public void setHelpDefinition(HelpDefinition helpDefinition)

Deprecated.

The pageHelp element provides the keys to obtain a help description from the database. On document JSP pages, a help icon may be rendered. If this tag is specified, then the filename of this page will be located in the value of the parameter specified by the namespace, detail type, and name. The value of the parameter is relative to the value of the "externalizable.help.url" property in ConfigurationService (see KualiHelpAction). parameterNamespace: namespace of the parameter that has the path to the help page parameterName: name of the parameter that has the path to the help page parameterDetailType: detail type of the parameter that has the path to the help page

setHeaderTabNavigateTo

public void setHeaderTabNavigateTo(String suffix)

Deprecated.

The navigateTo element is the forward name in the struts-config file.

isDisabled

public boolean isDisabled()

Deprecated.

setDisabled

public void setDisabled(boolean disabled)

Deprecated.

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                      Class otherBusinessObjectClass)

Deprecated.

Description copied from class: DataDictionaryDefinitionBase

Default implementation so that all subclasses do not need to implement this deprecated method.

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class DataDictionaryDefinitionBase

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

DataDictionaryDefinition.completeValidation(java.lang.Class, java.lang.Class)