com.edustructures.sifworks.reporting
Class SLContact

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.reporting.SLContact

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SLContact
extends SIFKeyedElement

Typically used to provide the state information about a student's parents and legal guardians.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SLContact()
Constructor

SLContact(Relationship relationship)
Constructor that accepts values for all mandatory fields

Method Summary

void	addName(Name value) Adds a new <Name> child element.
void	addName(NameType type, java.lang.String lastName, java.lang.String firstName) Adds a new <Name> repeatable element.
java.lang.String	getEducationalLevel() Gets the value of the <EducationalLevel> 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
Name	getName(NameType type) Gets a Name object instance.
Name[]	getNames() Gets all Name object instances.
OtherId	getOtherId() Gets the value of the <OtherId> element.
Relationship	getRelationship() Gets the value of the <Relationship> element.
void	removeName(NameType type) Removes a Name object instance.
void	removeOtherId() Removes the OtherId child element previously created by calling setOtherId
void	removeRelationship() Removes the Relationship child element previously created by calling setRelationship
void	setEducationalLevel(EducationalLevelCode value) Sets the value of the <EducationalLevel> element.
void	setEducationalLevel(java.lang.String value) Sets the value of the <EducationalLevel> element as a String.
void	setNames(Name[] names) Sets an array of Name objects.
void	setOtherId(OtherId value) Sets the value of the <OtherId> element.
void	setOtherId(OtherIdType type, java.lang.String value) Sets the value of the <OtherId> child element.
void	setRelationship(Relationship value) Sets the value of the <Relationship> element.
void	setRelationship(RelationshipCode code) Sets the value of the <Relationship> child element.

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

SLContact

public SLContact()

Constructor

SLContact

public SLContact(Relationship relationship)

Constructor that accepts values for all mandatory fields

Parameters:

relationship - Relationship to the student.

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

setRelationship

public void setRelationship(Relationship value)

Sets the value of the <Relationship> element.

The SIF specification defines the meaning of this element as: "Relationship to the student."

Parameters:

value - A Relationship object

Since:

1.5r1

setRelationship

public void setRelationship(RelationshipCode code)

Sets the value of the <Relationship> child element. This form of setRelationship is provided as a convenience method that is functionally equivalent to the version of setRelationship that accepts a single Relationship object.

Parameters:

code - Code representing the relationship.

Since:

1.5r1

getRelationship

public Relationship getRelationship()

Gets the value of the <Relationship> element.

The SIF specification defines the meaning of this element as: "Relationship to the student."

Returns:

A Relationship object

Since:

1.5r1

removeRelationship

public void removeRelationship()

Removes the Relationship child element previously created by calling setRelationship

Since:

1.5r1

addName

public void addName(Name value)

Adds a new <Name> child element.

The SIF specification defines the meaning of this element as: "The name(s) of the contact."

Parameters:

value - A Name object

Since:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

setOtherId

public void setOtherId(OtherId value)

Sets the value of the <OtherId> element.

The SIF specification defines the meaning of this element as: "The ID(s) of the contact."

Parameters:

value - A OtherId object

Since:

1.5r1

setOtherId

public void setOtherId(OtherIdType type,
                       java.lang.String value)

Sets the value of the <OtherId> child element. This form of setOtherId is provided as a convenience method that is functionally equivalent to the version of setOtherId that accepts a single OtherId object.

Parameters:

type - Code that defines the type of this other ID. Note: A subset of valid values may be specified in data objects.

value - Gets or sets the content value of the <OtherId> element

Since:

1.5r1

getOtherId

public OtherId getOtherId()

Gets the value of the <OtherId> element.

The SIF specification defines the meaning of this element as: "The ID(s) of the contact."

Returns:

An OtherId object

Since:

1.5r1

removeOtherId

public void removeOtherId()

Removes the OtherId child element previously created by calling setOtherId

Since:

1.5r1

getEducationalLevel

public java.lang.String getEducationalLevel()

Gets the value of the <EducationalLevel> element.

The SIF specification defines the meaning of this element as: "Highest level of education completed by the contact."

Returns:

The EducationalLevel element of this object.

Since:

1.5r1

setEducationalLevel

public void setEducationalLevel(EducationalLevelCode value)

Sets the value of the <EducationalLevel> element.

The SIF specification defines the meaning of this element as: "Highest level of education completed by the contact."

Parameters:

value - A constant defined by the EducationalLevelCode class

Since:

1.5r1

setEducationalLevel

public void setEducationalLevel(java.lang.String value)

Sets the value of the <EducationalLevel> element as a String.

The SIF specification defines the meaning of this element as: "Highest level of education completed by the contact."

Parameters:

value - The value as a String

Since:

1.5r1