org.kuali.rice.kns.datadictionary

Class FieldDefinition

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.kns.datadictionary.FieldDefinition

All Implemented Interfaces:

Serializable, Cloneable, FieldDefinitionI, Copyable, DataDictionaryDefinition, DictionaryBean

Direct Known Subclasses:

InquiryCollectionDefinition, InquirySubSectionHeaderDefinition

Deprecated.

Use Field subclasses.

@Deprecated
public class FieldDefinition
extends DataDictionaryDefinitionBase
implements FieldDefinitionI

Contains field-related information for DataDictionary entries. Used by lookups and inquiries. Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	additionalDisplayAttributeName Deprecated.
protected String	alternateDisplayAttributeName Deprecated.
protected String	attributeName Deprecated.
protected String	defaultValue Deprecated.
protected Class<? extends ValueFinder>	defaultValueFinderClass Deprecated.
protected String	displayEditMode Deprecated.
protected Mask	displayMask Deprecated.
protected boolean	forceInquiry Deprecated.
protected boolean	forceLookup Deprecated.
protected boolean	hidden Deprecated.
protected Integer	maxLength Deprecated.
protected boolean	noDirectInquiry Deprecated.
protected boolean	noInquiry Deprecated.
protected boolean	noLookup Deprecated.
protected String	quickfinderParameterString Deprecated.
protected Class<? extends ValueFinder>	quickfinderParameterStringBuilderClass Deprecated.
protected boolean	readOnly Deprecated.
protected boolean	required Deprecated.
protected boolean	total Deprecated.
protected boolean	treatWildcardsAndOperatorsAsLiteral Deprecated.
protected boolean	triggerOnChange Deprecated.
protected boolean	useShortLabel 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
FieldDefinition() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Deprecated. Directly validate simple fields.
String	getAdditionalDisplayAttributeName() Deprecated.
String	getAlternateDisplayAttributeName() Deprecated.
String	getAttributeName() Deprecated.
String	getDefaultValue() Deprecated.
Class<? extends ValueFinder>	getDefaultValueFinderClass() Deprecated.
String	getDisplayEditMode() Deprecated.
Mask	getDisplayMask() Deprecated.
Integer	getMaxLength() Deprecated. Gets the maxLength attribute.
String	getName() Deprecated.
String	getQuickfinderParameterString() Deprecated. the quickfinderParameterString is a comma separated list of parameter/value pairs, of the format "param1=value1,param2=value2", where the parameters correspond to attributes of the target class for the quickfinder, and the values to literals that those attributes will default to when the quickfinder is used.
Class<? extends ValueFinder>	getQuickfinderParameterStringBuilderClass() Deprecated. the quickfinderParameterStringBuilderClass specifies the java class that will be used to determine the default value(s) for field(s) on the target lookup when the quickfinder is used.
boolean	isForceInquiry() Deprecated.
boolean	isForceLookup() Deprecated.
boolean	isHidden() Deprecated.
boolean	isNoDirectInquiry() Deprecated.
boolean	isNoInquiry() Deprecated.
boolean	isNoLookup() Deprecated.
boolean	isReadOnly() Deprecated.
boolean	isReadOnlyAfterAdd() Deprecated.
boolean	isRequired() Deprecated.
boolean	isTotal() Deprecated.
boolean	isTreatWildcardsAndOperatorsAsLiteral() Deprecated.
boolean	isTriggerOnChange() Deprecated.
boolean	isUseShortLabel() Deprecated.
void	setAdditionalDisplayAttributeName(String additionalDisplayAttributeName) Deprecated.
void	setAlternateDisplayAttributeName(String alternateDisplayAttributeName) Deprecated.
void	setAttributeName(String attributeName) Deprecated. Sets attributeName to the given value.
void	setDefaultValue(String defaultValue) Deprecated. The defaultValue element will pre-load the specified value into the field.
void	setDefaultValueFinderClass(Class<? extends ValueFinder> defaultValueFinderClass) Deprecated. The defaultValueFinderClass specifies the java class that will be used to determine the default value of a field.
void	setDisplayEditMode(String displayEditMode) Deprecated.
void	setDisplayMask(Mask displayMask) Deprecated. The displayMask element specifies the type of masking to be used to hide the value from un-authorized users.
void	setForceInquiry(boolean forceInquiry) Deprecated. forceInquiry = true means that the displayed field value will always be made inquirable (this attribute is not used within the code).
void	setForceLookup(boolean forceLookup) Deprecated. forceLookup = this attribute is not used
void	setHidden(boolean hidden) Deprecated.
void	setMaxLength(Integer maxLength) Deprecated. maxLength = the maximum allowable length of the field in the lookup result fields.
void	setNoDirectInquiry(boolean noDirectInquiry) Deprecated.
void	setNoInquiry(boolean noInquiry) Deprecated. noInquiry = true means that the displayed field will never be made inquirable.
void	setNoLookup(boolean noLookup) Deprecated. noLookup = true means that field should not include magnifying glass (i.e.
void	setQuickfinderParameterString(String quickfinderParameterString) Deprecated.
void	setQuickfinderParameterStringBuilderClass(Class<? extends ValueFinder> quickfinderParameterStringBuilderClass) Deprecated. See getQuickfinderParameterStringBuilderClass()
void	setReadOnly(boolean readOnly) Deprecated.
void	setRequired(boolean required) Deprecated. required = true means that the user must enter something into the search criterion lookup field
void	setTotal(boolean total) Deprecated.
void	setTreatWildcardsAndOperatorsAsLiteral(boolean treatWildcardsAndOperatorsAsLiteralOnLookups) Deprecated.
void	setTriggerOnChange(boolean triggerOnChange) Deprecated.
void	setUseShortLabel(boolean useShortLabel) Deprecated.
String	toString() Deprecated.

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, wait, wait, wait

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

attributeName

protected String attributeName

Deprecated.

required

protected boolean required

Deprecated.

forceInquiry

protected boolean forceInquiry

Deprecated.

noInquiry

protected boolean noInquiry

Deprecated.

noDirectInquiry

protected boolean noDirectInquiry

Deprecated.

forceLookup

protected boolean forceLookup

Deprecated.

noLookup

protected boolean noLookup

Deprecated.

useShortLabel

protected boolean useShortLabel

Deprecated.

defaultValue

protected String defaultValue

Deprecated.

defaultValueFinderClass

protected Class<? extends ValueFinder> defaultValueFinderClass

Deprecated.

quickfinderParameterString

protected String quickfinderParameterString

Deprecated.

quickfinderParameterStringBuilderClass

protected Class<? extends ValueFinder> quickfinderParameterStringBuilderClass

Deprecated.

maxLength

protected Integer maxLength

Deprecated.

displayEditMode

protected String displayEditMode

Deprecated.

displayMask

protected Mask displayMask

Deprecated.

hidden

protected boolean hidden

Deprecated.

readOnly

protected boolean readOnly

Deprecated.

treatWildcardsAndOperatorsAsLiteral

protected boolean treatWildcardsAndOperatorsAsLiteral

Deprecated.

alternateDisplayAttributeName

protected String alternateDisplayAttributeName

Deprecated.

additionalDisplayAttributeName

protected String additionalDisplayAttributeName

Deprecated.

triggerOnChange

protected boolean triggerOnChange

Deprecated.

total

protected boolean total

Deprecated.

Constructor Detail

FieldDefinition

public FieldDefinition()

Deprecated.

Method Detail

getAttributeName

public String getAttributeName()

Deprecated.

Returns:

attributeName

setAttributeName

public void setAttributeName(String attributeName)

Deprecated.

Sets attributeName to the given value.

Parameters:

attributeName -

Throws:

IllegalArgumentException - if the given attributeName is blank

isRequired

public boolean isRequired()

Deprecated.

Returns:

true if this attribute is required

setRequired

public void setRequired(boolean required)

Deprecated.

required = true means that the user must enter something into the search criterion lookup field

isForceInquiry

public boolean isForceInquiry()

Deprecated.

Returns:

Returns the forceInquiry.

setForceInquiry

public void setForceInquiry(boolean forceInquiry)

Deprecated.

forceInquiry = true means that the displayed field value will always be made inquirable (this attribute is not used within the code).

isForceLookup

public boolean isForceLookup()

Deprecated.

Returns:

Returns the forceLookup.

setForceLookup

public void setForceLookup(boolean forceLookup)

Deprecated.

forceLookup = this attribute is not used

isNoInquiry

public boolean isNoInquiry()

Deprecated.

Returns:

Returns the noInquiry.

isNoDirectInquiry

public boolean isNoDirectInquiry()

Deprecated.

Returns:

Returns a boolean value indicating whether or not to provide a direct inquiry for the lookup field

setNoInquiry

public void setNoInquiry(boolean noInquiry)

Deprecated.

noInquiry = true means that the displayed field will never be made inquirable.

setNoDirectInquiry

public void setNoDirectInquiry(boolean noDirectInquiry)

Deprecated.

Parameters:

noInquiry - If true, the displayed field will not have a direct inquiry facility

isNoLookup

public boolean isNoLookup()

Deprecated.

Returns:

Returns the noLookup.

setNoLookup

public void setNoLookup(boolean noLookup)

Deprecated.

noLookup = true means that field should not include magnifying glass (i.e. quickfinder)

isUseShortLabel

public boolean isUseShortLabel()

Deprecated.

Returns:

the useShortLabel

setUseShortLabel

public void setUseShortLabel(boolean useShortLabel)

Deprecated.

Parameters:

useShortLabel - the useShortLabel to set

getDefaultValue

public String getDefaultValue()

Deprecated.

Returns:

Returns the defaultValue.

setDefaultValue

public void setDefaultValue(String defaultValue)

Deprecated.

The defaultValue element will pre-load the specified value into the field.

getQuickfinderParameterString

public String getQuickfinderParameterString()

Deprecated.

the quickfinderParameterString is a comma separated list of parameter/value pairs, of the format "param1=value1,param2=value2", where the parameters correspond to attributes of the target class for the quickfinder, and the values to literals that those attributes will default to when the quickfinder is used.

Returns:

the quickfinderParameterString

setQuickfinderParameterString

public void setQuickfinderParameterString(String quickfinderParameterString)

Deprecated.

Parameters:

quickfinderParameterString - the quickfinderParameterString to set. See getQuickfinderParameterString()

getQuickfinderParameterStringBuilderClass

public Class<? extends ValueFinder> getQuickfinderParameterStringBuilderClass()

Deprecated.

the quickfinderParameterStringBuilderClass specifies the java class that will be used to determine the default value(s) for field(s) on the target lookup when the quickfinder is used. The classname specified in this field must implement ValueFinder. See getQuickfinderParameterString() for the result string format.

Returns:

the quickfinderParameterStringBuilderClass

setQuickfinderParameterStringBuilderClass

public void setQuickfinderParameterStringBuilderClass(Class<? extends ValueFinder> quickfinderParameterStringBuilderClass)

Deprecated.

See getQuickfinderParameterStringBuilderClass()

Parameters:

quickfinderParameterStringBuilderClass - the quickfinderParameterStringBuilderClass to set

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                      Class otherBusinessObjectClass)

Deprecated.

Directly validate simple fields.

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:

org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

See Also:

Object.toString()

getName

public String getName()

Deprecated.

Specified by:

getName in interface FieldDefinitionI

getDisplayEditMode

public String getDisplayEditMode()

Deprecated.

setDisplayEditMode

public void setDisplayEditMode(String displayEditMode)

Deprecated.

getDisplayMask

public Mask getDisplayMask()

Deprecated.

setDisplayMask

public void setDisplayMask(Mask displayMask)

Deprecated.

The displayMask element specifies the type of masking to be used to hide the value from un-authorized users. There are three types of masking.

isReadOnlyAfterAdd

public boolean isReadOnlyAfterAdd()

Deprecated.

Specified by:

isReadOnlyAfterAdd in interface FieldDefinitionI

getMaxLength

public Integer getMaxLength()

Deprecated.

Gets the maxLength attribute.

Returns:

Returns the maxLength.

setMaxLength

public void setMaxLength(Integer maxLength)

Deprecated.

maxLength = the maximum allowable length of the field in the lookup result fields. In other contexts, like inquiries, this field has no effect.

getDefaultValueFinderClass

public Class<? extends ValueFinder> getDefaultValueFinderClass()

Deprecated.

Returns:

custom defaultValue class

setDefaultValueFinderClass

public void setDefaultValueFinderClass(Class<? extends ValueFinder> defaultValueFinderClass)

Deprecated.

The defaultValueFinderClass specifies the java class that will be used to determine the default value of a field. The classname specified in this field must implement ValueFinder

isHidden

public boolean isHidden()

Deprecated.

Returns:

the hidden

setHidden

public void setHidden(boolean hidden)

Deprecated.

Parameters:

hidden - If the ControlDefinition.isHidden == true then a corresponding LookupDefinition would automatically be removed from the search criteria. In some cases you might want the hidden field to be used as a search criteria. For example, in PersonImpl.xml a client might want to have the campus code hidden and preset to Bloomington. So when the search is run, only people from the bloomington campus are returned. So, if you want to have a hidden search criteria, set this variable to true. Defaults to false.

isReadOnly

public boolean isReadOnly()

Deprecated.

Returns:

the readOnly

setReadOnly

public void setReadOnly(boolean readOnly)

Deprecated.

Parameters:

readOnly - the readOnly to set

isTriggerOnChange

public boolean isTriggerOnChange()

Deprecated.

setTriggerOnChange

public void setTriggerOnChange(boolean triggerOnChange)

Deprecated.

isTreatWildcardsAndOperatorsAsLiteral

public boolean isTreatWildcardsAndOperatorsAsLiteral()

Deprecated.

Returns:

the treatWildcardsAndOperatorsAsLiteralOnLookups

setTreatWildcardsAndOperatorsAsLiteral

public void setTreatWildcardsAndOperatorsAsLiteral(boolean treatWildcardsAndOperatorsAsLiteralOnLookups)

Deprecated.

Parameters:

treatWildcardsAndOperatorsAsLiteralOnLookups - the treatWildcardsAndOperatorsAsLiteralOnLookups to set

getAlternateDisplayAttributeName

public String getAlternateDisplayAttributeName()

Deprecated.

Specified by:

getAlternateDisplayAttributeName in interface FieldDefinitionI

setAlternateDisplayAttributeName

public void setAlternateDisplayAttributeName(String alternateDisplayAttributeName)

Deprecated.

getAdditionalDisplayAttributeName

public String getAdditionalDisplayAttributeName()

Deprecated.

Specified by:

getAdditionalDisplayAttributeName in interface FieldDefinitionI

setAdditionalDisplayAttributeName

public void setAdditionalDisplayAttributeName(String additionalDisplayAttributeName)

Deprecated.

isTotal

public boolean isTotal()

Deprecated.

setTotal

public void setTotal(boolean total)

Deprecated.