org.kuali.rice.kim.bo.entity.dto
Class KimEntityNameInfo

java.lang.Object
  org.kuali.rice.kim.bo.entity.dto.KimInactivatableInfo
      org.kuali.rice.kim.bo.entity.dto.KimDefaultableInfo
          org.kuali.rice.kim.bo.entity.dto.KimEntityNameInfo

All Implemented Interfaces:

Serializable, KimEntityName, Defaultable, DefaultableInactivateable, Inactivateable

public class KimEntityNameInfo
extends KimDefaultableInfo
implements KimEntityName, Serializable

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

protected String	entityNameId
protected String	firstName
protected String	firstNameUnmasked
protected String	formattedName
protected String	formattedNameUnmasked
protected String	lastName
protected String	lastNameUnmasked
protected String	middleName
protected String	middleNameUnmasked
protected String	nameTypeCode
private static long	serialVersionUID
protected String	suffix
protected String	suffixUnmasked
protected boolean	suppressName
protected String	title
protected String	titleUnmasked

Fields inherited from class org.kuali.rice.kim.bo.entity.dto.KimDefaultableInfo

dflt

Fields inherited from class org.kuali.rice.kim.bo.entity.dto.KimInactivatableInfo

active

Constructor Summary

KimEntityNameInfo()
construct an empty KimEntityNameInfo

KimEntityNameInfo(KimEntityName name)
construct a KimEntityNameInfo derived from the given KimEntityName

Method Summary

String	getEntityNameId() Gets this KimEntityName's id.
String	getFirstName() Gets this KimEntityName's first name.
String	getFirstNameUnmasked() Gets this KimEntityName's unmasked first name.
String	getFormattedName() Return the entire name as the person or system wants it displayed.
String	getFormattedNameUnmasked() Gets this KimEntityName's unmasked formatted name.
String	getLastName() Gets this KimEntityName's last name.
String	getLastNameUnmasked() Gets this KimEntityName's unmasked last name.
String	getMiddleName() Gets this KimEntityName's middle name.
String	getMiddleNameUnmasked() Gets this KimEntityName's unmasked middle name.
String	getNameTypeCode() Gets this KimEntityName's type code.
String	getSuffix() Gets this KimEntityName's suffix.
String	getSuffixUnmasked() Gets this KimEntityName's unmasked suffix.
String	getTitle() Gets this KimEntityName's title.
String	getTitleUnmasked() Gets this KimEntityName's unmasked title.
boolean	isSuppressName()
void	setEntityNameId(String entityNameId)
void	setFirstName(String firstName)
void	setFirstNameUnmasked(String firstNameUnmasked)
void	setFormattedName(String formattedName)
void	setFormattedNameUnmasked(String formattedNameUnmasked)
void	setLastName(String lastName)
void	setLastNameUnmasked(String lastNameUnmasked)
void	setMiddleName(String middleName)
void	setMiddleNameUnmasked(String middleNameUnmasked)
void	setNameTypeCode(String nameTypeCode)
void	setSuffix(String suffix)
void	setSuffixUnmasked(String suffixUnmasked)
void	setSuppressName(boolean suppressName)
void	setTitle(String title)
void	setTitleUnmasked(String titleUnmasked)

Methods inherited from class org.kuali.rice.kim.bo.entity.dto.KimDefaultableInfo

isDefault, setDefault

Methods inherited from class org.kuali.rice.kim.bo.entity.dto.KimInactivatableInfo

isActive, setActive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.bo.Defaultable

isDefault, setDefault

Methods inherited from interface org.kuali.rice.kns.bo.Inactivateable

isActive, setActive

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

entityNameId

protected String entityNameId

nameTypeCode

protected String nameTypeCode

firstName

protected String firstName

firstNameUnmasked

protected String firstNameUnmasked

middleName

protected String middleName

middleNameUnmasked

protected String middleNameUnmasked

lastName

protected String lastName

lastNameUnmasked

protected String lastNameUnmasked

title

protected String title

titleUnmasked

protected String titleUnmasked

suffix

protected String suffix

suffixUnmasked

protected String suffixUnmasked

suppressName

protected boolean suppressName

formattedName

protected String formattedName

formattedNameUnmasked

protected String formattedNameUnmasked

Constructor Detail

KimEntityNameInfo

public KimEntityNameInfo()

construct an empty KimEntityNameInfo

KimEntityNameInfo

public KimEntityNameInfo(KimEntityName name)

construct a KimEntityNameInfo derived from the given KimEntityName

Method Detail

getEntityNameId

public String getEntityNameId()

Gets this KimEntityName's id.

Specified by:

getEntityNameId in interface KimEntityName

Returns:

the id for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getEntityNameId()

setEntityNameId

public void setEntityNameId(String entityNameId)

Parameters:

entityNameId - the entityNameId to set

getNameTypeCode

public String getNameTypeCode()

Gets this KimEntityName's type code.

Specified by:

getNameTypeCode in interface KimEntityName

Returns:

the type code for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getNameTypeCode()

setNameTypeCode

public void setNameTypeCode(String nameTypeCode)

Parameters:

nameTypeCode - the nameTypeCode to set

getFirstName

public String getFirstName()

Gets this KimEntityName's first name.

Specified by:

getFirstName in interface KimEntityName

Returns:

the first name for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getFirstName()

setFirstName

public void setFirstName(String firstName)

Parameters:

firstName - the firstName to set

getFirstNameUnmasked

public String getFirstNameUnmasked()

Gets this KimEntityName's unmasked first name.

Specified by:

getFirstNameUnmasked in interface KimEntityName

Returns:

the unmasked first name for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getFirstNameUnmasked()

setFirstNameUnmasked

public void setFirstNameUnmasked(String firstNameUnmasked)

Parameters:

firstNameUnmasked - the firstNameUnmasked to set

getMiddleName

public String getMiddleName()

Gets this KimEntityName's middle name.

Specified by:

getMiddleName in interface KimEntityName

Returns:

the middle name for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getMiddleName()

setMiddleName

public void setMiddleName(String middleName)

Parameters:

middleName - the middleName to set

getMiddleNameUnmasked

public String getMiddleNameUnmasked()

Gets this KimEntityName's unmasked middle name.

Specified by:

getMiddleNameUnmasked in interface KimEntityName

Returns:

the unmasked middle name for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getMiddleNameUnmasked()

setMiddleNameUnmasked

public void setMiddleNameUnmasked(String middleNameUnmasked)

Parameters:

middleNameUnmasked - the middleNameUnmasked to set

getLastName

public String getLastName()

Gets this KimEntityName's last name.

Specified by:

getLastName in interface KimEntityName

Returns:

the last name for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getLastName()

setLastName

public void setLastName(String lastName)

Parameters:

lastName - the lastName to set

getLastNameUnmasked

public String getLastNameUnmasked()

Gets this KimEntityName's unmasked last name.

Specified by:

getLastNameUnmasked in interface KimEntityName

Returns:

the unmasked last name for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getLastNameUnmasked()

setLastNameUnmasked

public void setLastNameUnmasked(String lastNameUnmasked)

Parameters:

lastNameUnmasked - the lastNameUnmasked to set

getTitle

public String getTitle()

Gets this KimEntityName's title.

Specified by:

getTitle in interface KimEntityName

Returns:

the title for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getTitle()

setTitle

public void setTitle(String title)

Parameters:

title - the title to set

getTitleUnmasked

public String getTitleUnmasked()

Gets this KimEntityName's unmasked title.

Specified by:

getTitleUnmasked in interface KimEntityName

Returns:

the unmasked title for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getTitleUnmasked()

setTitleUnmasked

public void setTitleUnmasked(String titleUnmasked)

Parameters:

titleUnmasked - the titleUnmasked to set

getSuffix

public String getSuffix()

Gets this KimEntityName's suffix.

Specified by:

getSuffix in interface KimEntityName

Returns:

the suffix for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getSuffix()

setSuffix

public void setSuffix(String suffix)

Parameters:

suffix - the suffix to set

getSuffixUnmasked

public String getSuffixUnmasked()

Gets this KimEntityName's unmasked suffix.

Specified by:

getSuffixUnmasked in interface KimEntityName

Returns:

the unmasked suffix for this KimEntityName, or null if none has been assigned.

See Also:

KimEntityName.getSuffixUnmasked()

setSuffixUnmasked

public void setSuffixUnmasked(String suffixUnmasked)

Parameters:

suffixUnmasked - the suffixUnmasked to set

isSuppressName

public boolean isSuppressName()

Specified by:

isSuppressName in interface KimEntityName

See Also:

KimEntityName.isSuppressName()

setSuppressName

public void setSuppressName(boolean suppressName)

Parameters:

suppressName - the suppressName to set

getFormattedName

public String getFormattedName()

Return the entire name as the person or system wants it displayed.

Specified by:

getFormattedName in interface KimEntityName

See Also:

KimEntityName.getFormattedName()

setFormattedName

public void setFormattedName(String formattedName)

Parameters:

formattedName - the formattedName to set

getFormattedNameUnmasked

public String getFormattedNameUnmasked()

Gets this KimEntityName's unmasked formatted name.

Specified by:

getFormattedNameUnmasked in interface KimEntityName

See Also:

KimEntityName.getFormattedNameUnmasked()

setFormattedNameUnmasked

public void setFormattedNameUnmasked(String formattedNameUnmasked)

Parameters:

formattedNameUnmasked - the formattedNameUnmasked to set