com.edustructures.sifworks.student
Class OtherNames

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<T>
                  com.edustructures.sifworks.SIFActionList<Name>
                      com.edustructures.sifworks.student.OtherNames

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Name>, java.util.Collection<Name>

public class OtherNames
extends SIFActionList<Name>

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

OtherNames()
Constructor

OtherNames(Name name)
Constructor that accepts values for all mandatory fields

Method Summary

void	addName(NameType type, java.lang.String lastName, java.lang.String firstName) Adds a new <Name> repeatable element.
Name	getName(NameType type) Gets a Name object instance.
Name[]	getNames() Gets all Name object instances.
void	removeName(NameType type) Removes a Name object instance.
void	setNames(Name[] names) Sets an array of Name objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

OtherNames

public OtherNames()

Constructor

OtherNames

public OtherNames(Name name)

Constructor that accepts values for all mandatory fields

Parameters:

name - Name of the staff member. Note: Type value of 04 may not occur here.

Method Detail

addName

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

Adds a new <Name> repeatable element. This form of setName is provided as a convenience method that is functionally equivalent to the version of setName that accepts a single Name object.

Parameters:

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

lastName - The last name.

firstName - The first name.

Since:

2.0

removeName

public void removeName(NameType type)

Removes a Name object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the Name object to remove by its Type value

Since:

2.0

getName

public Name getName(NameType type)

Gets a Name object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the Name object to return by its "Type" attribute value

Returns:

A Name object

Since:

2.0

getNames

public Name[] getNames()

Gets all Name object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of Name objects

Since:

2.0

setNames

public void setNames(Name[] names)

Sets an array of Name objects. All existing Name instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Names.

Since:

2.0