com.edustructures.sifworks.common
Class Name

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.Name

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Name
extends SIFKeyedElement

The name of a person

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Name()
Constructor

Name(NameType type, java.lang.String lastName, java.lang.String firstName)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getFirstName() Gets the value of the <FirstName> element.
java.lang.String	getFullName() Gets the value of the <FullName> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getLastName() Gets the value of the <LastName> element.
java.lang.String	getMiddleName() Gets the value of the <MiddleName> element.
java.lang.String	getPreferredName() Gets the value of the <PreferredName> element.
java.lang.String	getPrefix() Gets the value of the <Prefix> element.
java.lang.String	getSortName() Gets the value of the <SortName> element.
java.lang.String	getSuffix() Gets the value of the <Suffix> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	setFirstName(java.lang.String value) Sets the value of the <FirstName> element.
void	setFullName(java.lang.String value) Sets the value of the <FullName> element.
void	setLastName(java.lang.String value) Sets the value of the <LastName> element.
void	setMiddleName(java.lang.String value) Sets the value of the <MiddleName> element.
void	setPreferredName(java.lang.String value) Sets the value of the <PreferredName> element.
void	setPrefix(java.lang.String value) Sets the value of the <Prefix> element.
void	setSortName(java.lang.String value) Sets the value of the <SortName> element.
void	setSuffix(java.lang.String value) Sets the value of the <Suffix> element.
void	setType(NameType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Name

public Name()

Constructor

Name

public Name(NameType type,
            java.lang.String lastName,
            java.lang.String firstName)

Constructor that accepts values for all mandatory fields

Parameters:

type - Code that specifies what type of name this is. If unsure, use 04.

lastName - The last name.

firstName - The first name.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Code that specifies what type of name this is. If unsure, use 04."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(NameType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Code that specifies what type of name this is. If unsure, use 04."

Parameters:

value - A constant defined by the NameType class

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "Code that specifies what type of name this is. If unsure, use 04."

Parameters:

value - The value as a String

Since:

1.1

getPrefix

public java.lang.String getPrefix()

Gets the value of the <Prefix> element.

The SIF specification defines the meaning of this element as: "A prefix associated with the name like Mr., Ms., etc."

Returns:

The Prefix element of this object.

Since:

1.1

setPrefix

public void setPrefix(java.lang.String value)

Sets the value of the <Prefix> element.

The SIF specification defines the meaning of this element as: "A prefix associated with the name like Mr., Ms., etc."

Parameters:

value - A String object

Since:

1.1

getLastName

public java.lang.String getLastName()

Gets the value of the <LastName> element.

The SIF specification defines the meaning of this element as: "The last name."

Returns:

The LastName element of this object.

Since:

1.1

setLastName

public void setLastName(java.lang.String value)

Sets the value of the <LastName> element.

The SIF specification defines the meaning of this element as: "The last name."

Parameters:

value - A String object

Since:

1.1

getFirstName

public java.lang.String getFirstName()

Gets the value of the <FirstName> element.

The SIF specification defines the meaning of this element as: "The first name."

Returns:

The FirstName element of this object.

Since:

1.1

setFirstName

public void setFirstName(java.lang.String value)

Sets the value of the <FirstName> element.

The SIF specification defines the meaning of this element as: "The first name."

Parameters:

value - A String object

Since:

1.1

getMiddleName

public java.lang.String getMiddleName()

Gets the value of the <MiddleName> element.

The SIF specification defines the meaning of this element as: "The middle name or initial."

Returns:

The MiddleName element of this object.

Since:

1.1

setMiddleName

public void setMiddleName(java.lang.String value)

Sets the value of the <MiddleName> element.

The SIF specification defines the meaning of this element as: "The middle name or initial."

Parameters:

value - A String object

Since:

1.1

getSuffix

public java.lang.String getSuffix()

Gets the value of the <Suffix> element.

The SIF specification defines the meaning of this element as: "Generation of suffix like II, Jr., etc."

Returns:

The Suffix element of this object.

Since:

1.1

setSuffix

public void setSuffix(java.lang.String value)

Sets the value of the <Suffix> element.

The SIF specification defines the meaning of this element as: "Generation of suffix like II, Jr., etc."

Parameters:

value - A String object

Since:

1.1

getPreferredName

public java.lang.String getPreferredName()

Gets the value of the <PreferredName> element.

The SIF specification defines the meaning of this element as: "This is a name that the person prefers to be called by."

Returns:

The PreferredName element of this object.

Since:

1.1

setPreferredName

public void setPreferredName(java.lang.String value)

Sets the value of the <PreferredName> element.

The SIF specification defines the meaning of this element as: "This is a name that the person prefers to be called by."

Parameters:

value - A String object

Since:

1.1

getSortName

public java.lang.String getSortName()

Gets the value of the <SortName> element.

The SIF specification defines the meaning of this element as: "This is the name to be used for sorting purposes."

Returns:

The SortName element of this object.

Since:

1.1

setSortName

public void setSortName(java.lang.String value)

Sets the value of the <SortName> element.

The SIF specification defines the meaning of this element as: "This is the name to be used for sorting purposes."

Parameters:

value - A String object

Since:

1.1

getFullName

public java.lang.String getFullName()

Gets the value of the <FullName> element.

The SIF specification defines the meaning of this element as: "A free text field for the complete name."

Returns:

The FullName element of this object.

Since:

1.1

setFullName

public void setFullName(java.lang.String value)

Sets the value of the <FullName> element.

The SIF specification defines the meaning of this element as: "A free text field for the complete name."

Parameters:

value - A String object

Since:

1.1