org.kuali.rice.krad.datadictionary

Class HelpDefinition

java.lang.Object

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.krad.datadictionary.HelpDefinition

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

public class HelpDefinition
extends DataDictionaryDefinitionBase
implements Serializable

The help 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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	parameterDetailType
protected String	parameterName
protected String	parameterNamespace

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

id

Constructor Summary

Constructors

Constructor and Description
HelpDefinition() Constructs a HelpDefinition.

Method Summary

Modifier and Type	Method and Description
void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field references refer to actual fields of some specific class.
String	getParameterDetailType()
String	getParameterName()
String	getParameterNamespace()
void	setParameterDetailType(String parameterDetailType) parameterDetailType: detail type of the parameter that has the path to the help page
void	setParameterName(String parameterName) parameterName: name of the parameter that has the path to the help page
void	setParameterNamespace(String parameterNamespace) parameterNamespace: namespace of the parameter that has the path to the help page

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

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

parameterNamespace

protected String parameterNamespace

parameterDetailType

protected String parameterDetailType

parameterName

protected String parameterName

Constructor Detail

HelpDefinition

public HelpDefinition()

Constructs a HelpDefinition.

Method Detail

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Description copied from interface: DataDictionaryDefinition

Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field references refer to actual fields of some specific class.

Specified by:

completeValidation in interface DataDictionaryDefinition

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)

getParameterName

public String getParameterName()

Returns:

setParameterName

public void setParameterName(String parameterName)

parameterName: name of the parameter that has the path to the help page

getParameterNamespace

public String getParameterNamespace()

Returns:

setParameterNamespace

public void setParameterNamespace(String parameterNamespace)

parameterNamespace: namespace of the parameter that has the path to the help page

getParameterDetailType

public String getParameterDetailType()

setParameterDetailType

public void setParameterDetailType(String parameterDetailType)

parameterDetailType: detail type of the parameter that has the path to the help page