org.kuali.rice.kns.datadictionary.control
Class KualiUserControlDefinition

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.control.ControlDefinitionBase
          org.kuali.rice.kns.datadictionary.control.KualiUserControlDefinition

All Implemented Interfaces:

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

public class KualiUserControlDefinition
extends ControlDefinitionBase

The kualiUser element defines a control that identifies a Kuali user. As an example, consider a person with the following: User ID = JPJONES Universal User ID = 3583663872 Employee ID = 0000123456 Name = JONES,JOHN p This control defines a field in which the user can enter the User Id or choose a user using the magnifying glass lookup. After a user is selected, user name will be displayed under the User ID. When using this control, the names of other attributes must be specified to allow the control to function: universalIdAttributeName - attribute that provides the Universal User Id - e.g. 3583663872 userIdAttributeName - attribute that provides the User Id - e.g. JPJONES personNameAttributeName - attribute that provides the User Name - e.g. JONES,JOHN P

See Also:

Serialized Form

Field Summary

protected String	personNameAttributeName
protected String	universalIdAttributeName
protected String	userIdAttributeName

Fields inherited from class org.kuali.rice.kns.datadictionary.control.ControlDefinitionBase

businessObjectClass, cols, datePicker, expandedTextArea, includeBlankRow, includeKeyInLabel, keyAttribute, labelAttribute, ranged, rows, script, size, valuesFinderClass

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

id

Constructor Summary

KualiUserControlDefinition()

Method Summary

String	getPersonNameAttributeName() Gets the personNameAttributeName attribute.
String	getUniversalIdAttributeName() Gets the universalIdAttributeName attribute.
String	getUserIdAttributeName() Gets the userIdAttributeName attribute.
boolean	isKualiUser()
void	setPersonNameAttributeName(String personNameAttributeName) personNameAttributeName - attribute that provides the User Name - e.g.
void	setUniversalIdAttributeName(String universalIdAttributeName) universalIdAttributeName - attribute that provides the Universal User Id - e.g.
void	setUserIdAttributeName(String userIdAttributeName) userIdAttributeName - attribute that provides the User Id - e.g.
String	toString()

Methods inherited from class org.kuali.rice.kns.datadictionary.control.ControlDefinitionBase

completeValidation, equals, getBusinessObjectClass, getCols, getIncludeBlankRow, getIncludeKeyInLabel, getKeyAttribute, getLabelAttribute, getRows, getScript, getSize, getValuesFinderClass, hasScript, isApcSelect, isButton, isCheckbox, isCurrency, isDatePicker, isExpandedTextArea, isFile, isHidden, isLink, isLookupHidden, isLookupReadonly, isMultiselect, isRadio, isRanged, isSelect, isText, isTextarea, isWorkflowWorkgroup, setBusinessObjectClass, setCols, setDatePicker, setExpandedTextArea, setIncludeBlankRow, setIncludeKeyInLabel, setKeyAttribute, setLabelAttribute, setRanged, setRows, setScript, setSize, setValuesFinderClass

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

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.datadictionary.DataDictionaryDefinition

getId

Field Detail

universalIdAttributeName

protected String universalIdAttributeName

userIdAttributeName

protected String userIdAttributeName

personNameAttributeName

protected String personNameAttributeName

Constructor Detail

KualiUserControlDefinition

public KualiUserControlDefinition()

Method Detail

isKualiUser

public boolean isKualiUser()

Specified by:

isKualiUser in interface ControlDefinition

Overrides:

isKualiUser in class ControlDefinitionBase

Returns:

true if the ControlDefinition instance represents a kualiUser control

See Also:

ControlDefinition.isKualiUser()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getPersonNameAttributeName

public String getPersonNameAttributeName()

Gets the personNameAttributeName attribute.

Returns:

Returns the personNameAttributeName.

setPersonNameAttributeName

public void setPersonNameAttributeName(String personNameAttributeName)

personNameAttributeName - attribute that provides the User Name - e.g. JONES,JOHN P

getUniversalIdAttributeName

public String getUniversalIdAttributeName()

Gets the universalIdAttributeName attribute.

Returns:

Returns the universalIdAttributeName.

setUniversalIdAttributeName

public void setUniversalIdAttributeName(String universalIdAttributeName)

universalIdAttributeName - attribute that provides the Universal User Id - e.g. 3583663872

getUserIdAttributeName

public String getUserIdAttributeName()

Gets the userIdAttributeName attribute.

Returns:

Returns the userIdAttributeName.

setUserIdAttributeName

public void setUserIdAttributeName(String userIdAttributeName)

userIdAttributeName - attribute that provides the User Id - e.g. JPJONES